[1a55dac4] | 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 |
|
---|
[475d4388] | 7 | <!ENTITY upower-download-http "https://gitlab.freedesktop.org/upower/upower/-/archive/v&upower-version;/upower-v&upower-version;.tar.bz2">
|
---|
[1a55dac4] | 8 | <!ENTITY upower-download-ftp " ">
|
---|
[fe04ab5] | 9 | <!ENTITY upower-md5sum "bfd6e3275e61d7e097b53eb2b216fffa">
|
---|
| 10 | <!ENTITY upower-size "136 KB">
|
---|
| 11 | <!ENTITY upower-buildsize "6.5 MB (add 1.1 MB for tests)">
|
---|
[23adab8] | 12 | <!ENTITY upower-time "less than 0.1 SBU (using parallelism=4, add 0.6 SBU for tests)">
|
---|
[1a55dac4] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="upower" xreflabel="UPower-&upower-version;">
|
---|
| 16 | <?dbhtml filename="upower.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>UPower-&upower-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="upower">
|
---|
| 22 | <primary sortas="a-UPower">UPower</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to UPower</title>
|
---|
| 27 |
|
---|
[b84342d6] | 28 | <para>
|
---|
[5a82b26f] | 29 | The <application>UPower</application> package provides an interface for
|
---|
[b84342d6] | 30 | enumerating power devices, listening to device events and querying history
|
---|
| 31 | and statistics. Any application or service on the system can access the
|
---|
| 32 | org.freedesktop.UPower service via the system message bus.
|
---|
| 33 | </para>
|
---|
[1a55dac4] | 34 |
|
---|
[acd88fc] | 35 | &lfs113_checked;
|
---|
[1a55dac4] | 36 |
|
---|
| 37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 38 | <itemizedlist spacing="compact">
|
---|
| 39 | <listitem>
|
---|
[b84342d6] | 40 | <para>
|
---|
| 41 | Download (HTTP): <ulink url="&upower-download-http;"/>
|
---|
| 42 | </para>
|
---|
[1a55dac4] | 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
[b84342d6] | 45 | <para>
|
---|
| 46 | Download (FTP): <ulink url="&upower-download-ftp;"/>
|
---|
| 47 | </para>
|
---|
[1a55dac4] | 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
[b84342d6] | 50 | <para>
|
---|
| 51 | Download MD5 sum: &upower-md5sum;
|
---|
| 52 | </para>
|
---|
[1a55dac4] | 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
[b84342d6] | 55 | <para>
|
---|
| 56 | Download size: &upower-size;
|
---|
| 57 | </para>
|
---|
[1a55dac4] | 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
[b84342d6] | 60 | <para>
|
---|
| 61 | Estimated disk space required: &upower-buildsize;
|
---|
| 62 | </para>
|
---|
[1a55dac4] | 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
[b84342d6] | 65 | <para>
|
---|
| 66 | Estimated build time: &upower-time;
|
---|
| 67 | </para>
|
---|
[1a55dac4] | 68 | </listitem>
|
---|
| 69 | </itemizedlist>
|
---|
| 70 |
|
---|
| 71 | <bridgehead renderas="sect3">UPower Dependencies</bridgehead>
|
---|
| 72 |
|
---|
| 73 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[c341539] | 74 | <para role="required">
|
---|
[f175d6f6] | 75 | <xref linkend="libgudev"/>,
|
---|
| 76 | <xref linkend="libusb"/>, and
|
---|
| 77 | <xref linkend="polkit"/>
|
---|
[c341539] | 78 | </para>
|
---|
| 79 |
|
---|
[4c2be438] | 80 | <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
|
---|
| 81 | <para role="optional">
|
---|
[c341539] | 82 | <xref linkend="gobject-introspection"/>
|
---|
| 83 | </para>
|
---|
[1a55dac4] | 84 |
|
---|
| 85 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[c341539] | 86 | <para role="optional">
|
---|
[dbea07b] | 87 | <xref linkend="gtk-doc"/>,
|
---|
[d4236e0] | 88 | <xref linkend="libxslt"/>,
|
---|
| 89 | <xref linkend="docbook-xsl"/>,
|
---|
[3bb415b] | 90 | <xref linkend="pygobject3"/>,
|
---|
[63a0217] | 91 | <xref linkend="python-dbusmock"/>,
|
---|
| 92 | <xref linkend="umockdev"/> (for part of the test suite), and
|
---|
| 93 | <ulink url="https://libimobiledevice.org/">libimobiledevice</ulink>
|
---|
[c341539] | 94 | </para>
|
---|
[1a55dac4] | 95 |
|
---|
| 96 | </sect2>
|
---|
| 97 |
|
---|
[88d8c967] | 98 | <sect2 role="kernel" id="upower-kernel" revision="systemd">
|
---|
| 99 | <!-- With UPower-0.9.11's hardening of the systemd unit file,
|
---|
[c884c4b] | 100 | User Namespace Support (CONFIG_USER_NS) is now required. Without this,
|
---|
| 101 | you will get "ERROR 213/USER" out of a 'systemctl start upower'. -->
|
---|
[88d8c967] | 102 | <title>Kernel Configuration</title>
|
---|
[8558044] | 103 |
|
---|
[88d8c967] | 104 | <para>
|
---|
| 105 | Enable the following options in the kernel configuration and recompile the
|
---|
| 106 | kernel if necessary:
|
---|
| 107 | </para>
|
---|
| 108 |
|
---|
[e7cd19a] | 109 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 110 | href="upower-systemd-kernel.xml"/>
|
---|
[88d8c967] | 111 |
|
---|
| 112 | <indexterm zone="upower upower-kernel">
|
---|
| 113 | <primary sortas="d-upower">upower</primary>
|
---|
| 114 | </indexterm>
|
---|
| 115 | </sect2>
|
---|
[8558044] | 116 |
|
---|
[1a55dac4] | 117 | <sect2 role="installation">
|
---|
| 118 | <title>Installation of UPower</title>
|
---|
| 119 |
|
---|
[d9c3a6d5] | 120 | <para>
|
---|
[fc7f3a5] | 121 | First, remove an unneeded dependency from a test:
|
---|
[d9c3a6d5] | 122 | </para>
|
---|
| 123 |
|
---|
| 124 | <screen><userinput>sed '/parse_version/d' -i src/linux/integration-test.py</userinput></screen>
|
---|
| 125 |
|
---|
[b84342d6] | 126 | <para>
|
---|
| 127 | Install <application>UPower</application> by running the following
|
---|
| 128 | commands:
|
---|
| 129 | </para>
|
---|
[1a55dac4] | 130 |
|
---|
[91318eb] | 131 | <screen revision="sysv"><userinput>mkdir build &&
|
---|
| 132 | cd build &&
|
---|
| 133 |
|
---|
| 134 | meson setup .. \
|
---|
| 135 | --prefix=/usr \
|
---|
| 136 | --buildtype=release \
|
---|
| 137 | -Dgtk-doc=false \
|
---|
| 138 | -Dman=false \
|
---|
| 139 | -Dsystemdsystemunitdir=no \
|
---|
| 140 | -Dudevrulesdir=/usr/lib/udev/rules.d &&
|
---|
[475d4388] | 141 | ninja</userinput></screen>
|
---|
| 142 |
|
---|
[d9c3a6d5] | 143 | <screen revision="systemd"><userinput>mkdir build &&
|
---|
[475d4388] | 144 | cd build &&
|
---|
[91318eb] | 145 | meson setup .. \
|
---|
| 146 | --prefix=/usr \
|
---|
[475d4388] | 147 | --buildtype=release \
|
---|
| 148 | -Dgtk-doc=false \
|
---|
[91318eb] | 149 | -Dman=false &&
|
---|
[475d4388] | 150 | ninja</userinput></screen>
|
---|
[1a55dac4] | 151 |
|
---|
[09951b1] | 152 | <!-- On my system with LANG=zh_CN.UTF-8, one test attempted to compare
|
---|
| 153 | Chinese error message with English references and failed.
|
---|
| 154 | LC_ALL=C fixes the problem. -->
|
---|
[fe04ab5] | 155 | <!-- Headphone hotplug (bluetooth and AUX) was tested and seems to work
|
---|
| 156 | okay even with the test faliures. Maybe it's wants headphones plugged
|
---|
| 157 | in during the test? Regardless, it can be safely ignored. -->
|
---|
[b84342d6] | 158 | <para>
|
---|
[09951b1] | 159 | To test the results, issue: <command>LC_ALL=C ninja test</command>. Some
|
---|
[fd69a62] | 160 | checks may not pass due to missing files. Test suite should be run from
|
---|
[fe04ab5] | 161 | a local GUI session started with dbus-launch. 2 tests relating to the
|
---|
| 162 | headphone hotplug feature are known to fail, these can be safely ignored
|
---|
| 163 | as the headphone functionality does still work.
|
---|
[b84342d6] | 164 | </para>
|
---|
[1a55dac4] | 165 |
|
---|
[b84342d6] | 166 | <para>
|
---|
| 167 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 168 | </para>
|
---|
[1a55dac4] | 169 |
|
---|
[09951b1] | 170 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[1a55dac4] | 171 |
|
---|
| 172 | </sect2>
|
---|
| 173 |
|
---|
| 174 | <sect2 role="commands">
|
---|
| 175 | <title>Command Explanations</title>
|
---|
| 176 |
|
---|
[475d4388] | 177 | <para>
|
---|
| 178 | <parameter>-Dgtk-doc=false</parameter>: Prevents building the
|
---|
[c884c4b] | 179 | documentation. Remove this if you have <application>GTK-Doc</application>
|
---|
[475d4388] | 180 | installed and wish to build the documentation.
|
---|
| 181 | </para>
|
---|
| 182 |
|
---|
| 183 | <para>
|
---|
| 184 | <parameter>-Dman=false</parameter>: Prevents building the
|
---|
[d4236e0] | 185 | manual pages. Remove this if you have <xref linkend='libxslt'/> and
|
---|
| 186 | <xref linkend='docbook-xsl'/> installed and wish to build the manual
|
---|
| 187 | pages.
|
---|
[475d4388] | 188 | </para>
|
---|
| 189 |
|
---|
| 190 | <para revision="sysv">
|
---|
| 191 | <parameter>-Dsystemdsystemunitdir=no</parameter>: Removes
|
---|
| 192 | the dependency on <application>systemd</application>.
|
---|
| 193 | </para>
|
---|
[3990efec] | 194 |
|
---|
[475d4388] | 195 | <para revision="sysv">
|
---|
| 196 | <parameter>-Dudevrulesdir=/usr/lib/udev/rules.d</parameter>: Tells
|
---|
| 197 | the build system where to install <application>udev</application>
|
---|
[c884c4b] | 198 | rules because the information is missing in
|
---|
[475d4388] | 199 | <filename>/usr/lib/pkgconfig/libudev.pc</filename>
|
---|
| 200 | </para>
|
---|
[1a55dac4] | 201 |
|
---|
| 202 | </sect2>
|
---|
| 203 |
|
---|
[5d696ec2] | 204 | <sect2 role="configuration" revision="systemd">
|
---|
| 205 |
|
---|
| 206 | <title>Configuring UPower</title>
|
---|
| 207 | <!-- timer statistics have been removed from kernel (since 4.11)
|
---|
| 208 | I do not know if there is a replacement. See
|
---|
| 209 | https://patchwork.kernel.org/patch/9561519
|
---|
| 210 | and https://bugs.freedesktop.org/show_bug.cgi?id=100626
|
---|
[00c4d39] | 211 |
|
---|
[b84342d6] | 212 | <para>
|
---|
| 213 | To use the command <command>upower -w</command> for information about
|
---|
[01701da9] | 214 | processor wakeups (this command is used by <phrase revision="sysv">
|
---|
| 215 | <ulink url="&gnome-download-http;/gnome-power-manager/">gnome-power-manager</ulink></phrase><phrase revision="systemd"><xref linkend="gnome-power-manager"/></phrase>)
|
---|
[b84342d6] | 216 | you need to enable CONFIG_TIMER_STATS. This is achieved in
|
---|
| 217 | <command>make menuconfig</command> by going to the 'kernel-hacking'
|
---|
| 218 | menu and selecting 'Collect kernel timers statistics'.
|
---|
| 219 | </para>
|
---|
[5d696ec2] | 220 | -->
|
---|
[475d4388] | 221 | <sect3 id="upower-init">
|
---|
[1552ac8] | 222 | <title>Systemd Unit</title>
|
---|
| 223 |
|
---|
| 224 | <para>
|
---|
[ddd9384] | 225 | To start the <command>UPower</command> service at boot,
|
---|
[1552ac8] | 226 | enable the previously installed systemd unit by
|
---|
| 227 | running the following command as the
|
---|
| 228 | <systemitem class="username">root</systemitem> user:
|
---|
| 229 | </para>
|
---|
| 230 |
|
---|
| 231 | <indexterm zone="upower upower-init">
|
---|
| 232 | <primary sortas="f-upower">upower</primary>
|
---|
| 233 | </indexterm>
|
---|
| 234 |
|
---|
| 235 | <screen role="root"><userinput>systemctl enable upower</userinput></screen>
|
---|
| 236 |
|
---|
| 237 | </sect3>
|
---|
[8558044] | 238 |
|
---|
[00c4d39] | 239 | </sect2>
|
---|
[1552ac8] | 240 |
|
---|
[1a55dac4] | 241 | <sect2 role="content">
|
---|
| 242 | <title>Contents</title>
|
---|
| 243 |
|
---|
| 244 | <segmentedlist>
|
---|
[ddd9384] | 245 | <segtitle>Installed Program<!--
|
---|
| 246 | See below... <phrase revision="systemd">s</phrase>--></segtitle>
|
---|
[b35ec46c] | 247 | <segtitle>Installed Libraries</segtitle>
|
---|
[1a55dac4] | 248 | <segtitle>Installed Directories</segtitle>
|
---|
| 249 |
|
---|
| 250 | <seglistitem>
|
---|
[c341539] | 251 | <seg>
|
---|
[ddd9384] | 252 | upower
|
---|
| 253 | <!-- <phrase revision="systemd"> and upowerd</phrase>
|
---|
| 254 | Upowerd should not be listed, as it is in /usr/libexec, and is not supposed
|
---|
| 255 | to be run by a user. Furthermore, upowerd is also in sysv, and there is no
|
---|
| 256 | reason so single out systemd here. -->
|
---|
[c341539] | 257 | </seg>
|
---|
| 258 | <seg>
|
---|
| 259 | libupower-glib.so
|
---|
| 260 | </seg>
|
---|
| 261 | <seg>
|
---|
[7ded7e3] | 262 | /etc/UPower,
|
---|
[df9fb20] | 263 | /usr/include/libupower-glib, and
|
---|
[7ded7e3] | 264 | /var/lib/upower
|
---|
[c341539] | 265 | </seg>
|
---|
[1a55dac4] | 266 | </seglistitem>
|
---|
| 267 | </segmentedlist>
|
---|
| 268 |
|
---|
| 269 | <variablelist>
|
---|
| 270 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 271 | <?dbfo list-presentation="list"?>
|
---|
| 272 | <?dbhtml list-presentation="table"?>
|
---|
| 273 |
|
---|
| 274 | <varlistentry id="upower-prog">
|
---|
| 275 | <term><command>upower</command></term>
|
---|
| 276 | <listitem>
|
---|
[b84342d6] | 277 | <para>
|
---|
[4c24eb0a] | 278 | is the <application>UPower</application> command line tool
|
---|
[b84342d6] | 279 | </para>
|
---|
[1a55dac4] | 280 | <indexterm zone="upower upower-prog">
|
---|
| 281 | <primary sortas="b-upower">upower</primary>
|
---|
| 282 | </indexterm>
|
---|
| 283 | </listitem>
|
---|
| 284 | </varlistentry>
|
---|
[ddd9384] | 285 | <!-- See above
|
---|
[1552ac8] | 286 | <varlistentry id="upowerd" revision="systemd">
|
---|
| 287 | <term><command>upowerd</command></term>
|
---|
| 288 | <listitem>
|
---|
| 289 | <para>
|
---|
| 290 | is the <application>UPower</application> Daemon. It provides the
|
---|
| 291 | org.freedesktop.UPower service on the system message bus.
|
---|
| 292 | </para>
|
---|
| 293 | <indexterm zone="upower upowerd">
|
---|
| 294 | <primary sortas="b-upowerd">upowerd</primary>
|
---|
| 295 | </indexterm>
|
---|
| 296 | </listitem>
|
---|
[ddd9384] | 297 | </varlistentry>-->
|
---|
[1552ac8] | 298 |
|
---|
[1a55dac4] | 299 | <varlistentry id="libupower-glib">
|
---|
[caed4c52] | 300 | <term><filename class="libraryfile">libupower-glib.so</filename></term>
|
---|
[1a55dac4] | 301 | <listitem>
|
---|
[b84342d6] | 302 | <para>
|
---|
[4c24eb0a] | 303 | contains the <application>UPower</application> API functions
|
---|
[b84342d6] | 304 | </para>
|
---|
[1a55dac4] | 305 | <indexterm zone="upower libupower-glib">
|
---|
[c341539] | 306 | <primary sortas="c-libupower-glib">libupower-glib.so</primary>
|
---|
[1a55dac4] | 307 | </indexterm>
|
---|
| 308 | </listitem>
|
---|
| 309 | </varlistentry>
|
---|
| 310 |
|
---|
| 311 | </variablelist>
|
---|
| 312 |
|
---|
| 313 | </sect2>
|
---|
| 314 |
|
---|
| 315 | </sect1>
|
---|