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 |
|
---|
7 | <!ENTITY upower-download-http "https://gitlab.freedesktop.org/upower/upower/uploads/93cfe7c8d66ed486001c4f3f55399b7a/upower-&upower-version;.tar.xz">
|
---|
8 | <!ENTITY upower-download-ftp " ">
|
---|
9 | <!ENTITY upower-md5sum "abe6acb617f11f2e8dbd9846fcf86e24">
|
---|
10 | <!ENTITY upower-size "424 KB">
|
---|
11 | <!ENTITY upower-buildsize "11 MB (add 3MB for tssts)">
|
---|
12 | <!ENTITY upower-time "0.1 SBU (add 0.1 SBU for tests)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="upower" xreflabel="UPower-&upower-version;">
|
---|
16 | <?dbhtml filename="upower.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>UPower-&upower-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="upower">
|
---|
26 | <primary sortas="a-UPower">UPower</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to UPower</title>
|
---|
31 |
|
---|
32 | <para>
|
---|
33 | The <application>UPower</application> package provides an interface to
|
---|
34 | enumerating power devices, listening to device events and querying history
|
---|
35 | and statistics. Any application or service on the system can access the
|
---|
36 | org.freedesktop.UPower service via the system message bus.
|
---|
37 | </para>
|
---|
38 |
|
---|
39 | &lfs90_checked;
|
---|
40 |
|
---|
41 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
42 | <itemizedlist spacing="compact">
|
---|
43 | <listitem>
|
---|
44 | <para>
|
---|
45 | Download (HTTP): <ulink url="&upower-download-http;"/>
|
---|
46 | </para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>
|
---|
50 | Download (FTP): <ulink url="&upower-download-ftp;"/>
|
---|
51 | </para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>
|
---|
55 | Download MD5 sum: &upower-md5sum;
|
---|
56 | </para>
|
---|
57 | </listitem>
|
---|
58 | <listitem>
|
---|
59 | <para>
|
---|
60 | Download size: &upower-size;
|
---|
61 | </para>
|
---|
62 | </listitem>
|
---|
63 | <listitem>
|
---|
64 | <para>
|
---|
65 | Estimated disk space required: &upower-buildsize;
|
---|
66 | </para>
|
---|
67 | </listitem>
|
---|
68 | <listitem>
|
---|
69 | <para>
|
---|
70 | Estimated build time: &upower-time;
|
---|
71 | </para>
|
---|
72 | </listitem>
|
---|
73 | </itemizedlist>
|
---|
74 |
|
---|
75 | <bridgehead renderas="sect3">UPower Dependencies</bridgehead>
|
---|
76 |
|
---|
77 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
78 | <para role="required">
|
---|
79 | <xref linkend="dbus-glib"/>,
|
---|
80 | <xref linkend="libgudev"/>,
|
---|
81 | <xref linkend="libusb"/>, and
|
---|
82 | <xref linkend="polkit"/>
|
---|
83 | </para>
|
---|
84 |
|
---|
85 | <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
|
---|
86 | <para role="optional">
|
---|
87 | <xref linkend="gobject-introspection"/>
|
---|
88 | </para>
|
---|
89 |
|
---|
90 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
91 | <para role="optional">
|
---|
92 | <xref linkend="gtk-doc"/>,
|
---|
93 | <xref linkend="pygobject3"/>,
|
---|
94 | <xref linkend="python-dbusmock"/>, and
|
---|
95 | <ulink url="https://github.com/martinpitt/umockdev">umockdev</ulink>
|
---|
96 | (for part of the testsuite).
|
---|
97 | </para>
|
---|
98 |
|
---|
99 | <para condition="html" role="usernotes">User Notes:
|
---|
100 | <ulink url="&blfs-wiki;/upower"/>
|
---|
101 | </para>
|
---|
102 | </sect2>
|
---|
103 |
|
---|
104 | <sect2 role="kernel" id="upower-kernel" revision="systemd">
|
---|
105 | <!-- With UPower-0.9.11's hardening of the systemd unit file,
|
---|
106 | User Namespace Support is now required. Without this, you get
|
---|
107 | "ERROR 213/USER" out of a 'systemctl start upower'. -->
|
---|
108 | <title>Kernel Configuration</title>
|
---|
109 |
|
---|
110 | <para>
|
---|
111 | Enable the following options in the kernel configuration and recompile the
|
---|
112 | kernel if necessary:
|
---|
113 | </para>
|
---|
114 |
|
---|
115 | <screen><literal>General Setup --->
|
---|
116 | [*] Namespaces support ---> [CONFIG_NAMESPACES]
|
---|
117 | [*] User namespace [CONFIG_USER_NS]</literal></screen>
|
---|
118 |
|
---|
119 | <indexterm zone="upower upower-kernel">
|
---|
120 | <primary sortas="d-upower">upower</primary>
|
---|
121 | </indexterm>
|
---|
122 | </sect2>
|
---|
123 |
|
---|
124 | <sect2 role="installation">
|
---|
125 | <title>Installation of UPower</title>
|
---|
126 |
|
---|
127 | <para>
|
---|
128 | Install <application>UPower</application> by running the following
|
---|
129 | commands:
|
---|
130 | </para>
|
---|
131 |
|
---|
132 | <screen><userinput>./configure --prefix=/usr \
|
---|
133 | --sysconfdir=/etc \
|
---|
134 | --localstatedir=/var \
|
---|
135 | --enable-deprecated \
|
---|
136 | --disable-static &&
|
---|
137 | make</userinput></screen>
|
---|
138 |
|
---|
139 | <para>
|
---|
140 | To test the results, issue: <command>make check</command>. Some
|
---|
141 | checks may not pass due to missing files. Test suite should be run from
|
---|
142 | a local GUI session started with dbus-launch.
|
---|
143 | </para>
|
---|
144 |
|
---|
145 | <para>
|
---|
146 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
147 | </para>
|
---|
148 |
|
---|
149 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
150 |
|
---|
151 | </sect2>
|
---|
152 |
|
---|
153 | <sect2 role="commands">
|
---|
154 | <title>Command Explanations</title>
|
---|
155 |
|
---|
156 | <para>
|
---|
157 | <parameter>--enable-deprecated</parameter>: This switch enables
|
---|
158 | deprecated functionality which is still needed by some
|
---|
159 | applications.
|
---|
160 | </para>
|
---|
161 |
|
---|
162 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
163 | href="../../xincludes/static-libraries.xml"/>
|
---|
164 |
|
---|
165 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
166 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
167 |
|
---|
168 | </sect2>
|
---|
169 |
|
---|
170 | <sect2 role="configuration" revision="systemd">
|
---|
171 |
|
---|
172 | <title>Configuring UPower</title>
|
---|
173 | <!-- timer statistics have been removed from kernel (since 4.11)
|
---|
174 | I do not know if there is a replacement. See
|
---|
175 | https://patchwork.kernel.org/patch/9561519
|
---|
176 | and https://bugs.freedesktop.org/show_bug.cgi?id=100626
|
---|
177 |
|
---|
178 | <para>
|
---|
179 | To use the command <command>upower -w</command> for information about
|
---|
180 | processor wakeups (this command is used by <phrase revision="sysv"><ulink url="http://ftp.gnome.org/pub/gnome/sources/gnome-power-manager/">gnome-power-manager</ulink></phrase><phrase revision="systemd"><xref linkend="gnome-power-manager"/></phrase>)
|
---|
181 | you need to enable CONFIG_TIMER_STATS. This is achieved in
|
---|
182 | <command>make menuconfig</command> by going to the 'kernel-hacking'
|
---|
183 | menu and selecting 'Collect kernel timers statistics'.
|
---|
184 | </para>
|
---|
185 | -->
|
---|
186 | <sect3 id="upower-init" revision="systemd">
|
---|
187 | <title>Systemd Unit</title>
|
---|
188 |
|
---|
189 | <para>
|
---|
190 | To start the <command>UPower</command> service at boot,
|
---|
191 | enable the previously installed systemd unit by
|
---|
192 | running the following command as the
|
---|
193 | <systemitem class="username">root</systemitem> user:
|
---|
194 | </para>
|
---|
195 |
|
---|
196 | <indexterm zone="upower upower-init">
|
---|
197 | <primary sortas="f-upower">upower</primary>
|
---|
198 | </indexterm>
|
---|
199 |
|
---|
200 | <screen role="root"><userinput>systemctl enable upower</userinput></screen>
|
---|
201 |
|
---|
202 | </sect3>
|
---|
203 |
|
---|
204 | </sect2>
|
---|
205 |
|
---|
206 | <sect2 role="content">
|
---|
207 | <title>Contents</title>
|
---|
208 |
|
---|
209 | <segmentedlist>
|
---|
210 | <segtitle>Installed Program<!--
|
---|
211 | See below... <phrase revision="systemd">s</phrase>--></segtitle>
|
---|
212 | <segtitle>Installed Libraries</segtitle>
|
---|
213 | <segtitle>Installed Directories</segtitle>
|
---|
214 |
|
---|
215 | <seglistitem>
|
---|
216 | <seg>
|
---|
217 | upower
|
---|
218 | <!-- <phrase revision="systemd"> and upowerd</phrase>
|
---|
219 | Upowerd should not be listed, as it is in /usr/libexec, and is not supposed
|
---|
220 | to be run by a user. Furthermore, upowerd is also in sysv, and there is no
|
---|
221 | reason so single out systemd here. -->
|
---|
222 | </seg>
|
---|
223 | <seg>
|
---|
224 | libupower-glib.so
|
---|
225 | </seg>
|
---|
226 | <seg>
|
---|
227 | /etc/UPower,
|
---|
228 | /usr/include/libupower-glib, and
|
---|
229 | /var/lib/upower
|
---|
230 | </seg>
|
---|
231 | </seglistitem>
|
---|
232 | </segmentedlist>
|
---|
233 |
|
---|
234 | <variablelist>
|
---|
235 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
236 | <?dbfo list-presentation="list"?>
|
---|
237 | <?dbhtml list-presentation="table"?>
|
---|
238 |
|
---|
239 | <varlistentry id="upower-prog">
|
---|
240 | <term><command>upower</command></term>
|
---|
241 | <listitem>
|
---|
242 | <para>
|
---|
243 | is the <application>UPower</application> command line tool.
|
---|
244 | </para>
|
---|
245 | <indexterm zone="upower upower-prog">
|
---|
246 | <primary sortas="b-upower">upower</primary>
|
---|
247 | </indexterm>
|
---|
248 | </listitem>
|
---|
249 | </varlistentry>
|
---|
250 | <!-- See above
|
---|
251 | <varlistentry id="upowerd" revision="systemd">
|
---|
252 | <term><command>upowerd</command></term>
|
---|
253 | <listitem>
|
---|
254 | <para>
|
---|
255 | is the <application>UPower</application> Daemon. It provides the
|
---|
256 | org.freedesktop.UPower service on the system message bus.
|
---|
257 | </para>
|
---|
258 | <indexterm zone="upower upowerd">
|
---|
259 | <primary sortas="b-upowerd">upowerd</primary>
|
---|
260 | </indexterm>
|
---|
261 | </listitem>
|
---|
262 | </varlistentry>-->
|
---|
263 |
|
---|
264 | <varlistentry id="libupower-glib">
|
---|
265 | <term><filename class="libraryfile">libupower-glib.so</filename></term>
|
---|
266 | <listitem>
|
---|
267 | <para>
|
---|
268 | contains the <application>UPower</application> API functions.
|
---|
269 | </para>
|
---|
270 | <indexterm zone="upower libupower-glib">
|
---|
271 | <primary sortas="c-libupower-glib">libupower-glib.so</primary>
|
---|
272 | </indexterm>
|
---|
273 | </listitem>
|
---|
274 | </varlistentry>
|
---|
275 |
|
---|
276 | </variablelist>
|
---|
277 |
|
---|
278 | </sect2>
|
---|
279 |
|
---|
280 | </sect1>
|
---|