source: general/sysutils/upower.xml@ 45ab6c7

11.0 qt5new trunk
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 5 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

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