[7efbf3d1] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8dfc5c3] | 7 | <!ENTITY acpid-download-http "&sourceforge-dl;/acpid2/acpid-&acpid-version;.tar.xz">
|
---|
[7efbf3d1] | 8 | <!ENTITY acpid-download-ftp " ">
|
---|
[b7547d4] | 9 | <!ENTITY acpid-md5sum "599dd38681b5917eeeafb58176793952">
|
---|
[7fe07f59] | 10 | <!ENTITY acpid-size "152 KB">
|
---|
[2c5d6683] | 11 | <!ENTITY acpid-buildsize "1.9 MB">
|
---|
[f23c35f4] | 12 | <!ENTITY acpid-time "less than 0.1 SBU">
|
---|
[7efbf3d1] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="acpid" xreflabel="acpid-&acpid-version;">
|
---|
| 16 | <?dbhtml filename="acpid.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>acpid-&acpid-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="acpid">
|
---|
| 26 | <primary sortas="a-acpid">acpid</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to acpid</title>
|
---|
| 31 |
|
---|
| 32 | <para>
|
---|
| 33 | The <application>acpid</application> (Advanced Configuration and Power
|
---|
| 34 | Interface event daemon) is a completely flexible, totally extensible
|
---|
| 35 | daemon for delivering ACPI events. It listens on netlink interface and
|
---|
| 36 | when an event occurs, executes programs to handle the event. The programs
|
---|
| 37 | it executes are configured through a set of configuration files, which can
|
---|
| 38 | be dropped into place by packages or by the user.
|
---|
| 39 | </para>
|
---|
| 40 |
|
---|
[796bc663] | 41 | &lfs83_checked;
|
---|
[7efbf3d1] | 42 |
|
---|
| 43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 44 | <itemizedlist spacing="compact">
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download (HTTP): <ulink url="&acpid-download-http;"/>
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download (FTP): <ulink url="&acpid-download-ftp;"/>
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Download MD5 sum: &acpid-md5sum;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Download size: &acpid-size;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
| 66 | <para>
|
---|
| 67 | Estimated disk space required: &acpid-buildsize;
|
---|
| 68 | </para>
|
---|
| 69 | </listitem>
|
---|
| 70 | <listitem>
|
---|
| 71 | <para>
|
---|
| 72 | Estimated build time: &acpid-time;
|
---|
| 73 | </para>
|
---|
| 74 | </listitem>
|
---|
| 75 | </itemizedlist>
|
---|
| 76 |
|
---|
| 77 | <para condition="html" role="usernotes">User Notes:
|
---|
| 78 | <ulink url="&blfs-wiki;/acpid"/>
|
---|
| 79 | </para>
|
---|
| 80 | </sect2>
|
---|
| 81 |
|
---|
| 82 | <sect2 role="installation">
|
---|
| 83 | <title>Installation of acpid</title>
|
---|
| 84 |
|
---|
| 85 | <para>
|
---|
| 86 | Install <application>acpid</application> by
|
---|
| 87 | running the following commands:
|
---|
| 88 | </para>
|
---|
| 89 |
|
---|
[68d5b0e] | 90 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 91 | --docdir=/usr/share/doc/acpid-&acpid-version; &&
|
---|
[7efbf3d1] | 92 | make</userinput></screen>
|
---|
| 93 |
|
---|
| 94 | <para>
|
---|
| 95 | This package does not come with a test suite.
|
---|
| 96 | </para>
|
---|
| 97 |
|
---|
| 98 | <para>
|
---|
| 99 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 100 | </para>
|
---|
| 101 |
|
---|
[7fe07f59] | 102 | <screen role="root"><userinput>make install &&
|
---|
[7efbf3d1] | 103 | install -v -m755 -d /etc/acpi/events &&
|
---|
| 104 | cp -r samples /usr/share/doc/acpid-&acpid-version;</userinput></screen>
|
---|
| 105 |
|
---|
| 106 | </sect2>
|
---|
| 107 |
|
---|
| 108 | <sect2 role="configuration">
|
---|
| 109 | <title>Configuring acpid</title>
|
---|
| 110 |
|
---|
| 111 | <para>
|
---|
| 112 | <application>acpid</application> is configured by user defined events.
|
---|
| 113 | Place event files under
|
---|
| 114 | <filename class="directory">/etc/acpi/events</filename> directory. If an
|
---|
| 115 | event occurs, <command>acpid</command> recurses through the event files in
|
---|
| 116 | order to see if the regex defined after "event" matches. If they do,
|
---|
| 117 | action is executed.
|
---|
| 118 | </para>
|
---|
| 119 |
|
---|
| 120 | <para>
|
---|
| 121 | The following brief example will suspend the system when the laptop lid
|
---|
| 122 | is closed (it requires <xref linkend="pm-utils"/>):
|
---|
| 123 | </para>
|
---|
| 124 |
|
---|
| 125 | <screen role="root"><userinput>cat > /etc/acpi/events/lid << "EOF"
|
---|
| 126 | <literal>event=button/lid
|
---|
| 127 | action=/etc/acpi/lid.sh</literal>
|
---|
| 128 | EOF
|
---|
| 129 |
|
---|
| 130 | cat > /etc/acpi/lid.sh << "EOF"
|
---|
| 131 | <literal>#!/bin/sh
|
---|
| 132 | /bin/grep -q open /proc/acpi/button/lid/LID/state && exit 0
|
---|
| 133 | /usr/sbin/pm-suspend</literal>
|
---|
| 134 | EOF
|
---|
| 135 | chmod +x /etc/acpi/lid.sh</userinput></screen>
|
---|
| 136 |
|
---|
| 137 | <para>
|
---|
| 138 | Unfortunately, not every computer labels ACPI events in the same way. To
|
---|
| 139 | determine how your buttons are recognized, use the
|
---|
[af8a78d] | 140 | <command>acpi_listen</command> tool. Also, look in the <filename
|
---|
| 141 | class="directory">samples</filename> directory under <filename
|
---|
| 142 | class="directory">/usr/share/doc/acpid-&acpid-version;</filename>
|
---|
| 143 | for more examples.
|
---|
[7efbf3d1] | 144 | </para>
|
---|
| 145 |
|
---|
| 146 | <sect3 id="acpid-init">
|
---|
[d5497a2e] | 147 | <title><phrase revision="sysv">Boot Script</phrase>
|
---|
| 148 | <phrase revision="systemd">Systemd Socket</phrase></title>
|
---|
[7efbf3d1] | 149 |
|
---|
[d5497a2e] | 150 | <para revision="sysv">
|
---|
[7efbf3d1] | 151 | To automatically start <command>acpid</command> when the system is
|
---|
| 152 | rebooted, install the <filename>/etc/rc.d/init.d/acpid</filename>
|
---|
[d5497a2e] | 153 | boot script from the <xref linkend="bootscripts"/> package.
|
---|
| 154 | </para>
|
---|
| 155 |
|
---|
| 156 | <para revision="systemd">
|
---|
| 157 | To start the <command>acpid</command> daemon at boot,
|
---|
| 158 | install the systemd unit from the <xref linkend="systemd-units"/>
|
---|
| 159 | package by running the following command as the
|
---|
| 160 | <systemitem class="username">root</systemitem> user:
|
---|
[7efbf3d1] | 161 | </para>
|
---|
| 162 |
|
---|
| 163 | <indexterm zone="acpid acpid-init">
|
---|
| 164 | <primary sortas="f-acpid">acpid</primary>
|
---|
| 165 | </indexterm>
|
---|
| 166 |
|
---|
| 167 | <screen role="root"><userinput>make install-acpid</userinput></screen>
|
---|
| 168 |
|
---|
[d5497a2e] | 169 | <note revision="systemd">
|
---|
| 170 | <para>
|
---|
| 171 | This package uses socket based activation and will be started when
|
---|
| 172 | something needs it. No standalone unit file is provided for this
|
---|
| 173 | package.
|
---|
| 174 | </para>
|
---|
| 175 | </note>
|
---|
| 176 |
|
---|
[7efbf3d1] | 177 | </sect3>
|
---|
| 178 |
|
---|
| 179 | </sect2>
|
---|
| 180 |
|
---|
| 181 | <sect2 role="content">
|
---|
| 182 | <title>Contents</title>
|
---|
| 183 |
|
---|
| 184 | <segmentedlist>
|
---|
| 185 | <segtitle>Installed Programs</segtitle>
|
---|
| 186 | <segtitle>Installed Libraries</segtitle>
|
---|
[68d5b0e] | 187 | <segtitle>Installed Directories</segtitle>
|
---|
[7efbf3d1] | 188 |
|
---|
| 189 | <seglistitem>
|
---|
| 190 | <seg>
|
---|
[d3789ec7] | 191 | acpid, acpi_listen, and kacpimon
|
---|
[7efbf3d1] | 192 | </seg>
|
---|
| 193 | <seg>
|
---|
| 194 | None
|
---|
| 195 | </seg>
|
---|
| 196 | <seg>
|
---|
[68d5b0e] | 197 | /etc/acpi and /usr/share/doc/acpid-&acpid-version;
|
---|
[7efbf3d1] | 198 | </seg>
|
---|
| 199 | </seglistitem>
|
---|
| 200 | </segmentedlist>
|
---|
| 201 |
|
---|
| 202 | <variablelist>
|
---|
| 203 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 204 | <?dbfo list-presentation="list"?>
|
---|
| 205 | <?dbhtml list-presentation="table"?>
|
---|
| 206 |
|
---|
| 207 | <varlistentry id="acpid-prog">
|
---|
| 208 | <term><command>acpid</command></term>
|
---|
| 209 | <listitem>
|
---|
| 210 | <para>
|
---|
| 211 | is a program that listens for ACPI events and executes the rules
|
---|
| 212 | that match the received event.
|
---|
| 213 | </para>
|
---|
| 214 | <indexterm zone="acpid acpid-prog">
|
---|
| 215 | <primary sortas="b-acpid">acpid</primary>
|
---|
| 216 | </indexterm>
|
---|
| 217 | </listitem>
|
---|
| 218 | </varlistentry>
|
---|
| 219 |
|
---|
| 220 | <varlistentry id="acpi_listen">
|
---|
| 221 | <term><command>acpi_listen</command></term>
|
---|
| 222 | <listitem>
|
---|
| 223 | <para>
|
---|
| 224 | is a simple tool which connects to <command>acpid</command> and
|
---|
| 225 | listens for events.
|
---|
| 226 | </para>
|
---|
| 227 | <indexterm zone="acpid acpi_listen">
|
---|
| 228 | <primary sortas="b-acpi_listen">acpi_listen</primary>
|
---|
| 229 | </indexterm>
|
---|
| 230 | </listitem>
|
---|
| 231 | </varlistentry>
|
---|
| 232 |
|
---|
| 233 | <varlistentry id="kacpimon">
|
---|
| 234 | <term><command>kacpimon</command></term>
|
---|
| 235 | <listitem>
|
---|
| 236 | <para>
|
---|
| 237 | is a monitor program that connects to three sources of ACPI events
|
---|
| 238 | (events file, netlink and input layer) and then reports on what it
|
---|
| 239 | sees while it is connected.
|
---|
| 240 | </para>
|
---|
| 241 | <indexterm zone="acpid kacpimon">
|
---|
| 242 | <primary sortas="b-kacpimon">kacpimon</primary>
|
---|
| 243 | </indexterm>
|
---|
| 244 | </listitem>
|
---|
| 245 | </varlistentry>
|
---|
| 246 |
|
---|
| 247 | </variablelist>
|
---|
| 248 |
|
---|
| 249 | </sect2>
|
---|
| 250 |
|
---|
| 251 | </sect1>
|
---|