source: general/sysutils/upower.xml@ 640ece9

10.0 10.1 11.0 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 640ece9 was 640ece9, checked in by Ken Moffat <ken@…>, 14 months ago

Tags: basic qt and webengine, laxappearance, most of xfce (no audio on this machine, nor blank CDs).

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@23567 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 8.7 KB
Line 
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 &lfs10_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 <xref linkend="umockdev"/> (for part of the test suite).
96 </para>
97
98 <para condition="html" role="usernotes">User Notes:
99 <ulink url="&blfs-wiki;/upower"/>
100 </para>
101 </sect2>
102
103 <sect2 role="kernel" id="upower-kernel" revision="systemd">
104 <!-- With UPower-0.9.11's hardening of the systemd unit file,
105 User Namespace Support is now required. Without this, you get
106 "ERROR 213/USER" out of a 'systemctl start upower'. -->
107 <title>Kernel Configuration</title>
108
109 <para>
110 Enable the following options in the kernel configuration and recompile the
111 kernel if necessary:
112 </para>
113
114 <screen><literal>General Setup ---&gt;
115 [*] Namespaces support ---&gt; [CONFIG_NAMESPACES]
116 [*] User namespace [CONFIG_USER_NS]</literal></screen>
117
118 <indexterm zone="upower upower-kernel">
119 <primary sortas="d-upower">upower</primary>
120 </indexterm>
121 </sect2>
122
123 <sect2 role="installation">
124 <title>Installation of UPower</title>
125
126 <para>
127 Install <application>UPower</application> by running the following
128 commands:
129 </para>
130
131<screen><userinput>./configure --prefix=/usr \
132 --sysconfdir=/etc \
133 --localstatedir=/var \
134 --enable-deprecated \
135 --disable-static &amp;&amp;
136make</userinput></screen>
137
138 <para>
139 To test the results, issue: <command>make check</command>. Some
140 checks may not pass due to missing files. Test suite should be run from
141 a local GUI session started with dbus-launch.
142 </para>
143
144 <para>
145 Now, as the <systemitem class="username">root</systemitem> user:
146 </para>
147
148<screen role="root"><userinput>make install</userinput></screen>
149
150 </sect2>
151
152 <sect2 role="commands">
153 <title>Command Explanations</title>
154
155 <para>
156 <parameter>--enable-deprecated</parameter>: This switch enables
157 deprecated functionality which is still needed by some
158 applications.
159 </para>
160
161 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
162 href="../../xincludes/static-libraries.xml"/>
163
164 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
165 href="../../xincludes/gtk-doc-rebuild.xml"/>
166
167 </sect2>
168
169 <sect2 role="configuration" revision="systemd">
170
171 <title>Configuring UPower</title>
172<!-- timer statistics have been removed from kernel (since 4.11)
173 I do not know if there is a replacement. See
174 https://patchwork.kernel.org/patch/9561519
175 and https://bugs.freedesktop.org/show_bug.cgi?id=100626
176
177 <para>
178 To use the command <command>upower -w</command> for information about
179 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>)
180 you need to enable CONFIG_TIMER_STATS. This is achieved in
181 <command>make menuconfig</command> by going to the &apos;kernel-hacking&apos;
182 menu and selecting &apos;Collect kernel timers statistics&apos;.
183 </para>
184-->
185 <sect3 id="upower-init" revision="systemd">
186 <title>Systemd Unit</title>
187
188 <para>
189 To start the <command>UPower</command> service at boot,
190 enable the previously installed systemd unit by
191 running the following command as the
192 <systemitem class="username">root</systemitem> user:
193 </para>
194
195 <indexterm zone="upower upower-init">
196 <primary sortas="f-upower">upower</primary>
197 </indexterm>
198
199<screen role="root"><userinput>systemctl enable upower</userinput></screen>
200
201 </sect3>
202
203 </sect2>
204
205 <sect2 role="content">
206 <title>Contents</title>
207
208 <segmentedlist>
209 <segtitle>Installed Program<!--
210See below... <phrase revision="systemd">s</phrase>--></segtitle>
211 <segtitle>Installed Libraries</segtitle>
212 <segtitle>Installed Directories</segtitle>
213
214 <seglistitem>
215 <seg>
216 upower
217<!-- <phrase revision="systemd"> and upowerd</phrase>
218Upowerd should not be listed, as it is in /usr/libexec, and is not supposed
219to be run by a user. Furthermore, upowerd is also in sysv, and there is no
220reason so single out systemd here. -->
221 </seg>
222 <seg>
223 libupower-glib.so
224 </seg>
225 <seg>
226 /etc/UPower,
227 /usr/include/libupower-glib, and
228 /var/lib/upower
229 </seg>
230 </seglistitem>
231 </segmentedlist>
232
233 <variablelist>
234 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
235 <?dbfo list-presentation="list"?>
236 <?dbhtml list-presentation="table"?>
237
238 <varlistentry id="upower-prog">
239 <term><command>upower</command></term>
240 <listitem>
241 <para>
242 is the <application>UPower</application> command line tool.
243 </para>
244 <indexterm zone="upower upower-prog">
245 <primary sortas="b-upower">upower</primary>
246 </indexterm>
247 </listitem>
248 </varlistentry>
249<!-- See above
250 <varlistentry id="upowerd" revision="systemd">
251 <term><command>upowerd</command></term>
252 <listitem>
253 <para>
254 is the <application>UPower</application> Daemon. It provides the
255 org.freedesktop.UPower service on the system message bus.
256 </para>
257 <indexterm zone="upower upowerd">
258 <primary sortas="b-upowerd">upowerd</primary>
259 </indexterm>
260 </listitem>
261 </varlistentry>-->
262
263 <varlistentry id="libupower-glib">
264 <term><filename class="libraryfile">libupower-glib.so</filename></term>
265 <listitem>
266 <para>
267 contains the <application>UPower</application> API functions.
268 </para>
269 <indexterm zone="upower libupower-glib">
270 <primary sortas="c-libupower-glib">libupower-glib.so</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 </variablelist>
276
277 </sect2>
278
279</sect1>
Note: See TracBrowser for help on using the repository browser.