source: general/sysutils/upower.xml@ e59eceb

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY upower-download-http "http://upower.freedesktop.org/releases/upower-&upower-version;.tar.xz">
  <!ENTITY upower-download-ftp  " ">
  <!ENTITY upower-md5sum        "78800e1ac7f92b24aabdf433e38f75d2">
  <!ENTITY upower-size          "416 KB">
  <!ENTITY upower-buildsize     "13 MB (add 2 MB for tests)">
  <!ENTITY upower-time          "0.2 SBU">
]>

<sect1 id="upower" xreflabel="UPower-&upower-version;">
  <?dbhtml filename="upower.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>UPower-&upower-version;</title>

  <indexterm zone="upower">
    <primary sortas="a-UPower">UPower</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to UPower</title>

    <para>
      The <application>UPower</application> package provides an interface to
      enumerating power devices, listening to device events and querying history
      and statistics. Any application or service on the system can access the
      org.freedesktop.UPower service via the system message bus.
    </para>

    &lfs80_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&upower-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&upower-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &upower-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &upower-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &upower-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &upower-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">UPower Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="dbus-glib"/>,
      <xref linkend="libgudev"/>,
      <xref linkend="libusb"/>, and
      <xref linkend="polkit"/>
    </para>

    <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
    <para role="optional">
      <xref linkend="gobject-introspection"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/> and
      <xref linkend="python3"/> (used only in the testsuite).
    </para>

    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/upower"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of UPower</title>

    <para>
      Install <application>UPower</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr        \
            --sysconfdir=/etc    \
            --localstatedir=/var \
            --enable-deprecated  \
            --disable-static     &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>. Some
      checks may not pass due to missing files. Test suite should be run from
      a local GUI session started with dbus-launch.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>--enable-deprecated</parameter>: This switch enables
      deprecated functionality which is still needed by some
      applications.
    </para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring your kernel for UPower</title>

    <para>
      To use the command <command>upower -w</command> for information about
      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>)
      you need to enable CONFIG_TIMER_STATS.  This is achieved in
      <command>make menuconfig</command> by going to the &apos;kernel-hacking&apos;
      menu and selecting &apos;Collect kernel timers statistics&apos;.
    </para>

    <sect3  id="upower-init" revision="systemd">
      <title>Systemd Unit</title>

      <para>
        To start the <command>upowerd</command> daemon at boot,
        enable the previously installed systemd unit by
        running the following command as the
        <systemitem class="username">root</systemitem> user:
      </para>

      <indexterm zone="upower upower-init">
        <primary sortas="f-upower">upower</primary>
      </indexterm>

<screen role="root"><userinput>systemctl enable upower</userinput></screen>

    </sect3>
 
  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Program<phrase revision="systemd">s</phrase></segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          upower<phrase revision="systemd"> and upowerd</phrase>
        </seg>
        <seg>
          libupower-glib.so
        </seg>
        <seg>
          /etc/UPower,
          /usr/include/libupower-glib, and
          /var/lib/upower
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="upower-prog">
        <term><command>upower</command></term>
        <listitem>
          <para>
            is the <application>UPower</application> command line tool.
          </para>
          <indexterm zone="upower upower-prog">
            <primary sortas="b-upower">upower</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="upowerd" revision="systemd">
        <term><command>upowerd</command></term>
        <listitem>
          <para>
            is the <application>UPower</application> Daemon. It provides the
            org.freedesktop.UPower service on the system message bus.
          </para>
          <indexterm zone="upower upowerd">
            <primary sortas="b-upowerd">upowerd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libupower-glib">
        <term><filename class="libraryfile">libupower-glib.so</filename></term>
        <listitem>
          <para>
            contains the <application>UPower</application> API functions.
          </para>
          <indexterm zone="upower libupower-glib">
            <primary sortas="c-libupower-glib">libupower-glib.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>