[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[1a55dac4] | 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 " ">
|
---|
[2bd79d0d] | 9 | <!ENTITY upower-md5sum "2399845217a9c6e4510f66033fcd7cf6">
|
---|
| 10 | <!ENTITY upower-size "140 KB">
|
---|
| 11 | <!ENTITY upower-buildsize "5.5 MB (add 2.6 MB for tests)">
|
---|
| 12 | <!ENTITY upower-time "less than 0.1 SBU (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 |
|
---|
[1241ea19] | 35 | &lfs121_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">
|
---|
[a8163a4] | 75 | <xref linkend="libgudev"/> and
|
---|
| 76 | <xref linkend="libusb"/>
|
---|
[c341539] | 77 | </para>
|
---|
| 78 |
|
---|
[4c2be438] | 79 | <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
|
---|
| 80 | <para role="optional">
|
---|
[c0bc0a9] | 81 | &gobject-introspection;
|
---|
[c341539] | 82 | </para>
|
---|
[1a55dac4] | 83 |
|
---|
| 84 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[c341539] | 85 | <para role="optional">
|
---|
[dbea07b] | 86 | <xref linkend="gtk-doc"/>,
|
---|
[d4236e0] | 87 | <xref linkend="libxslt"/>,
|
---|
| 88 | <xref linkend="docbook-xsl"/>,
|
---|
[3bb415b] | 89 | <xref linkend="pygobject3"/>,
|
---|
[63a0217] | 90 | <xref linkend="python-dbusmock"/>,
|
---|
| 91 | <xref linkend="umockdev"/> (for part of the test suite), and
|
---|
| 92 | <ulink url="https://libimobiledevice.org/">libimobiledevice</ulink>
|
---|
[c341539] | 93 | </para>
|
---|
[1a55dac4] | 94 |
|
---|
| 95 | </sect2>
|
---|
| 96 |
|
---|
[88d8c967] | 97 | <sect2 role="kernel" id="upower-kernel" revision="systemd">
|
---|
| 98 | <!-- With UPower-0.9.11's hardening of the systemd unit file,
|
---|
[c884c4b] | 99 | User Namespace Support (CONFIG_USER_NS) is now required. Without this,
|
---|
| 100 | you will get "ERROR 213/USER" out of a 'systemctl start upower'. -->
|
---|
[88d8c967] | 101 | <title>Kernel Configuration</title>
|
---|
[8558044] | 102 |
|
---|
[88d8c967] | 103 | <para>
|
---|
| 104 | Enable the following options in the kernel configuration and recompile the
|
---|
| 105 | kernel if necessary:
|
---|
| 106 | </para>
|
---|
| 107 |
|
---|
[e7cd19a] | 108 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 109 | href="upower-systemd-kernel.xml"/>
|
---|
[88d8c967] | 110 |
|
---|
| 111 | <indexterm zone="upower upower-kernel">
|
---|
| 112 | <primary sortas="d-upower">upower</primary>
|
---|
| 113 | </indexterm>
|
---|
| 114 | </sect2>
|
---|
[8558044] | 115 |
|
---|
[1a55dac4] | 116 | <sect2 role="installation">
|
---|
| 117 | <title>Installation of UPower</title>
|
---|
| 118 |
|
---|
[b84342d6] | 119 | <para>
|
---|
| 120 | Install <application>UPower</application> by running the following
|
---|
| 121 | commands:
|
---|
| 122 | </para>
|
---|
[1a55dac4] | 123 |
|
---|
[91318eb] | 124 | <screen revision="sysv"><userinput>mkdir build &&
|
---|
| 125 | cd build &&
|
---|
| 126 |
|
---|
[7c83169b] | 127 | meson setup .. \
|
---|
| 128 | --prefix=/usr \
|
---|
| 129 | --buildtype=release \
|
---|
| 130 | -D gtk-doc=false \
|
---|
| 131 | -D man=false \
|
---|
| 132 | -D systemdsystemunitdir=no \
|
---|
| 133 | -D udevrulesdir=/usr/lib/udev/rules.d &&
|
---|
[475d4388] | 134 | ninja</userinput></screen>
|
---|
| 135 |
|
---|
[d9c3a6d5] | 136 | <screen revision="systemd"><userinput>mkdir build &&
|
---|
[475d4388] | 137 | cd build &&
|
---|
[91318eb] | 138 | meson setup .. \
|
---|
| 139 | --prefix=/usr \
|
---|
[475d4388] | 140 | --buildtype=release \
|
---|
[7c83169b] | 141 | -D gtk-doc=false \
|
---|
| 142 | -D man=false &&
|
---|
[475d4388] | 143 | ninja</userinput></screen>
|
---|
[1a55dac4] | 144 |
|
---|
[09951b1] | 145 | <!-- On my system with LANG=zh_CN.UTF-8, one test attempted to compare
|
---|
| 146 | Chinese error message with English references and failed.
|
---|
| 147 | LC_ALL=C fixes the problem. -->
|
---|
[fe04ab5] | 148 | <!-- Headphone hotplug (bluetooth and AUX) was tested and seems to work
|
---|
| 149 | okay even with the test faliures. Maybe it's wants headphones plugged
|
---|
| 150 | in during the test? Regardless, it can be safely ignored. -->
|
---|
[f5afe1b] | 151 | <!-- On a 32-bit machine, the following test failure can be observed:
|
---|
| 152 | ======================================================================
|
---|
| 153 | FAIL: test_battery_energy_charge_mixed (__main__.Tests.test_battery_energy_charge_mixed)
|
---|
| 154 | battery which reports both current charge and energy
|
---|
| 155 |
|
---|
| 156 | self.assertEqual(self.get_dbus_dev_property(bat0_up, 'Percentage'), 40.0)
|
---|
| 157 | AssertionError: 40.00000000000001 != 40.0
|
---|
| 158 |
|
---|
| 159 | This is known upstream as https://gitlab.freedesktop.org/upower/upower/-/issues/251
|
---|
| 160 | Not sure if this is an actual problem, but it seems to start and work
|
---|
[fc3c4b8] | 161 | properly -renodr
|
---|
| 162 |
|
---|
| 163 | test_bluetooth_le_device: upstream MR !207 -xry111 -->
|
---|
[f5afe1b] | 164 |
|
---|
[2bd79d0d] | 165 | <!-- On my system all 68 tests passed for v1.90.4.
|
---|
| 166 | Did not check on a 32-bit system. - bdubbs -->
|
---|
| 167 |
|
---|
[b84342d6] | 168 | <para>
|
---|
[2bd79d0d] | 169 | To test the results, issue: <command>LC_ALL=C ninja test</command>. The
|
---|
| 170 | test suite should be run from a local GUI session started with
|
---|
| 171 | dbus-launch. On 32-bit machines, one test will fail due to rounding
|
---|
| 172 | errors: <filename>Tests.test_battery_energy_charge_mixed</filename>. On
|
---|
| 173 | some systems, two tests relating to the headphone hotplug feature are
|
---|
| 174 | known to fail. Those can be safely ignored since the functionality still
|
---|
| 175 | works.
|
---|
[b84342d6] | 176 | </para>
|
---|
[1a55dac4] | 177 |
|
---|
[b84342d6] | 178 | <para>
|
---|
| 179 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 180 | </para>
|
---|
[1a55dac4] | 181 |
|
---|
[09951b1] | 182 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[1a55dac4] | 183 |
|
---|
| 184 | </sect2>
|
---|
| 185 |
|
---|
| 186 | <sect2 role="commands">
|
---|
| 187 | <title>Command Explanations</title>
|
---|
| 188 |
|
---|
[475d4388] | 189 | <para>
|
---|
[7c83169b] | 190 | <parameter>-D gtk-doc=false</parameter>: Prevents building the
|
---|
[c884c4b] | 191 | documentation. Remove this if you have <application>GTK-Doc</application>
|
---|
[475d4388] | 192 | installed and wish to build the documentation.
|
---|
| 193 | </para>
|
---|
| 194 |
|
---|
| 195 | <para>
|
---|
[7c83169b] | 196 | <parameter>-D man=false</parameter>: Prevents building the
|
---|
[d4236e0] | 197 | manual pages. Remove this if you have <xref linkend='libxslt'/> and
|
---|
| 198 | <xref linkend='docbook-xsl'/> installed and wish to build the manual
|
---|
| 199 | pages.
|
---|
[475d4388] | 200 | </para>
|
---|
| 201 |
|
---|
| 202 | <para revision="sysv">
|
---|
[7c83169b] | 203 | <parameter>-D systemdsystemunitdir=no</parameter>: Removes
|
---|
[475d4388] | 204 | the dependency on <application>systemd</application>.
|
---|
| 205 | </para>
|
---|
[3990efec] | 206 |
|
---|
[475d4388] | 207 | <para revision="sysv">
|
---|
[7c83169b] | 208 | <parameter>-D udevrulesdir=/usr/lib/udev/rules.d</parameter>: Tells
|
---|
[475d4388] | 209 | the build system where to install <application>udev</application>
|
---|
[c884c4b] | 210 | rules because the information is missing in
|
---|
[475d4388] | 211 | <filename>/usr/lib/pkgconfig/libudev.pc</filename>
|
---|
| 212 | </para>
|
---|
[1a55dac4] | 213 |
|
---|
| 214 | </sect2>
|
---|
| 215 |
|
---|
| 216 | <sect2 role="content">
|
---|
| 217 | <title>Contents</title>
|
---|
| 218 |
|
---|
| 219 | <segmentedlist>
|
---|
[ddd9384] | 220 | <segtitle>Installed Program<!--
|
---|
| 221 | See below... <phrase revision="systemd">s</phrase>--></segtitle>
|
---|
[b35ec46c] | 222 | <segtitle>Installed Libraries</segtitle>
|
---|
[1a55dac4] | 223 | <segtitle>Installed Directories</segtitle>
|
---|
| 224 |
|
---|
| 225 | <seglistitem>
|
---|
[c341539] | 226 | <seg>
|
---|
[ddd9384] | 227 | upower
|
---|
| 228 | <!-- <phrase revision="systemd"> and upowerd</phrase>
|
---|
| 229 | Upowerd should not be listed, as it is in /usr/libexec, and is not supposed
|
---|
| 230 | to be run by a user. Furthermore, upowerd is also in sysv, and there is no
|
---|
| 231 | reason so single out systemd here. -->
|
---|
[c341539] | 232 | </seg>
|
---|
| 233 | <seg>
|
---|
| 234 | libupower-glib.so
|
---|
| 235 | </seg>
|
---|
| 236 | <seg>
|
---|
[7ded7e3] | 237 | /etc/UPower,
|
---|
[df9fb20] | 238 | /usr/include/libupower-glib, and
|
---|
[7ded7e3] | 239 | /var/lib/upower
|
---|
[c341539] | 240 | </seg>
|
---|
[1a55dac4] | 241 | </seglistitem>
|
---|
| 242 | </segmentedlist>
|
---|
| 243 |
|
---|
| 244 | <variablelist>
|
---|
| 245 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 246 | <?dbfo list-presentation="list"?>
|
---|
| 247 | <?dbhtml list-presentation="table"?>
|
---|
| 248 |
|
---|
| 249 | <varlistentry id="upower-prog">
|
---|
| 250 | <term><command>upower</command></term>
|
---|
| 251 | <listitem>
|
---|
[b84342d6] | 252 | <para>
|
---|
[4c24eb0a] | 253 | is the <application>UPower</application> command line tool
|
---|
[b84342d6] | 254 | </para>
|
---|
[1a55dac4] | 255 | <indexterm zone="upower upower-prog">
|
---|
| 256 | <primary sortas="b-upower">upower</primary>
|
---|
| 257 | </indexterm>
|
---|
| 258 | </listitem>
|
---|
| 259 | </varlistentry>
|
---|
[ddd9384] | 260 | <!-- See above
|
---|
[1552ac8] | 261 | <varlistentry id="upowerd" revision="systemd">
|
---|
| 262 | <term><command>upowerd</command></term>
|
---|
| 263 | <listitem>
|
---|
| 264 | <para>
|
---|
| 265 | is the <application>UPower</application> Daemon. It provides the
|
---|
| 266 | org.freedesktop.UPower service on the system message bus.
|
---|
| 267 | </para>
|
---|
| 268 | <indexterm zone="upower upowerd">
|
---|
| 269 | <primary sortas="b-upowerd">upowerd</primary>
|
---|
| 270 | </indexterm>
|
---|
| 271 | </listitem>
|
---|
[ddd9384] | 272 | </varlistentry>-->
|
---|
[1552ac8] | 273 |
|
---|
[1a55dac4] | 274 | <varlistentry id="libupower-glib">
|
---|
[caed4c52] | 275 | <term><filename class="libraryfile">libupower-glib.so</filename></term>
|
---|
[1a55dac4] | 276 | <listitem>
|
---|
[b84342d6] | 277 | <para>
|
---|
[4c24eb0a] | 278 | contains the <application>UPower</application> API functions
|
---|
[b84342d6] | 279 | </para>
|
---|
[1a55dac4] | 280 | <indexterm zone="upower libupower-glib">
|
---|
[c341539] | 281 | <primary sortas="c-libupower-glib">libupower-glib.so</primary>
|
---|
[1a55dac4] | 282 | </indexterm>
|
---|
| 283 | </listitem>
|
---|
| 284 | </varlistentry>
|
---|
| 285 |
|
---|
| 286 | </variablelist>
|
---|
| 287 |
|
---|
| 288 | </sect2>
|
---|
| 289 |
|
---|
| 290 | </sect1>
|
---|