<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
    "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY legal SYSTEM "legal.xml">
  <!ENTITY GFDL  SYSTEM "fdl-appendix.xml">
  <!ENTITY app "GNOME Power Manager">
  <!ENTITY application "<application>&app;</application>">
  <!ENTITY appversion "2.15.4">
  <!ENTITY manrevision "2.15.4">
]>
<!--
      (Do not remove this comment block.)
  Template Maintained by the GNOME Documentation Project:
	  http://developer.gnome.org/projects/gdp
  Template version: 2.0 beta
  Template last modified Feb 12, 2002
-->

<!-- =============Document Header ============================= -->
<article id="index" lang="en">
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->

  <articleinfo>
    <title>&application; Manual</title>
    <copyright>
      <year>2006</year>
      <holder>Richard Hughes (richard@hughsie.com)</holder>
    </copyright>

  <!-- translators: uncomment this:

  <copyright>
   <year>2006</year>
   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
  </copyright>

  -->

<!-- An address can be added to the publisher information.  If a role is
     not specified, the publisher/author is the same for all versions of the
     document.  -->
    <publisher>
      <publishername>Richard Hughes</publishername>
    </publisher>

   &legal;
   <!-- This file  contains link to license for the documentation (GNU FDL), and
        other legal stuff such as "NO WARRANTY" statement. Please do not change
        any of this. -->

    <authorgroup>
      <author>
        <firstname>Richard</firstname>
        <surname>Hughes</surname>
	<email>richard@hughsie.com</email>
      </author>
<!-- This is appropriate place for other contributors: translators,
      maintainers,  etc. Commented out by default.
       <othercredit role="translator">
        <firstname>Latin</firstname>
        <surname>Translator 1</surname>
        <affiliation>
          <orgname>Latin Translation Team</orgname>
          <address> <email>translator@gnome.org</email> </address>
        </affiliation>
        <contrib>Latin translation</contrib>
      </othercredit>
-->
    </authorgroup>

    <revhistory>
      <revision>
        <revnumber>2.0</revnumber>
        <date>2006-02-19</date>
        <revdescription>
          <para role="author">Richard Hughes
            <email>richard@hughsie.com</email>
          </para>
          <para role="publisher">Richard Hughes</para>
        </revdescription>
      </revision>
    </revhistory>

    <legalnotice>
      <title>Feedback</title>
      <para>
        To report a bug or make a suggestion regarding the &app; application or
        this manual, follow the directions in the 
        <ulink url="http://www.gnome.org/projects/gnome-power-manager/"
	  type="http">GNOME Power Manager Contact Page</ulink>.
      </para>
<!-- Translators may also add here feedback address for translations -->
    </legalnotice>
  </articleinfo>

  <indexterm zone="index">
    <primary>GNOME Power Manager</primary>
  </indexterm>
  <indexterm zone="index">
    <primary>gnome-power-manager</primary>
  </indexterm>

<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
<section id="intro">
  <title>Introduction</title>
  <!-- manrevision 2.0 compatibility -->
  <anchor id="aboutex"/>
  <anchor id="notice"/>
  <indexterm>
    <primary>GNOME Power Manager</primary>
    <secondary>Manual</secondary>
    <tertiary>gnome-power-manager</tertiary>
  </indexterm>

  <para>
  The &app; session daemon is a power management daemon
  for the <systemitem>GNOME desktop</systemitem>
  </para>

  <section id="suspend-hibernate-differences">
    <title>Differences between suspend and hibernate</title>
    <para>
      The Suspend state is a power saving feature which is the lowest level of
      power consumption that preserves program data in the computers memory.
      When your computer is in the Suspended state, computation will not be
      performed until normal activity is resumed.
      It will not resume until signaled by an external event such as a keyboard
      button press.
      It generally takes a few seconds to suspend and then resume your computer.
    </para>
    <caution>
      <para>
        You still use a small amount of battery power whilst suspended, so is
        not recommended for the low power action.
        If you remove AC power on a desktop, or run out of battery power on a
        laptop then you will lose your work.
      </para>
    </caution>
    <para>
      The Hibernation state saves the complete state of the computer to hard
      disk and turns off the power, so that the computer appears to be off.
      It will not resume until signaled by an external event such as a
      keyboard button press.
      This is the lowest power sleeping state available.
      If you remove AC power on a desktop, or run out of battery power on a
      laptop then work will not be lost.
      It can take up to a minute or more to hibernate and wake your computer.
    </para>
  </section>
</section>

<section id="using">
  <title>Usage</title>
  <para>
    <application>&app;</application> is usually started in GNOME startup, but
    you can manually start <application>&app;</application> by doing:
  </para>
  <variablelist>
    <varlistentry>
      <term>Command line</term>
      <listitem>
    	<para>
    	  Type <command>gnome-power-manager --verbose --no-daemon</command>,
          then press <keycap>Return</keycap>:
        </para>
      </listitem>
    </varlistentry>
  </variablelist>
</section>

<section id="notify">
  <title>Notification Messages</title>
  <para>
    When &application; has started, the following notifications may be displayed.
  </para>

  <section id="notify-unplugged">
    <title>AC Adapter Unplugged</title>
    <figure>
      <title>&app; Notification when AC adapter is removed</title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpm-unplugged.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
    <note>
      <para>
        You can disable this notification by changing the gconf key
        <command>/apps/gnome-power-manager/notify_ac_adapter</command>.
      </para>
    </note>
  </section>

  <section id="notify-fully-charged">
    <title>Fully Charged</title>
    <figure>
      <title>&app; Notification when laptop primary button is fully charged</title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpm-charged.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
    <note>
      <para>
        You can disable this notification by changing the gconf key
        <command>/apps/gnome-power-manager/notify_fully_charged</command>.
      </para>
    </note>
    <note>
      <para>
        You will only get a repeat notification if your battery percentage charge
        drops below 95% and then is again fully charged.
        This prevents some machines from showing unwanted repeat notifications
        if the battery is incorrectly reporting the charged status.
      </para>
    </note>
  </section>

  <section id="notify-low">
  <title>Power Low</title>
    <para>
      When the battery is low, you will recieve the following notification.
      You should consider switching to battery power really soon.
    </para>
    <figure>
      <title>&app; Notification when battery power is low</title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpm-low.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
  </section>

  <section id="notify-critical">
  <title>Power Critical</title>
    <para>
      When the computer has run out of power, it will show this notification
      explaining what action is required.
      You can change the critical low action using the preferences tool.
    </para>
    <figure>
      <title>&app; Notification when the system power is critically low</title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpm-critical.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
  </section>

  <section id="notify-suspend-failure">
  <title>Suspend Failure</title>
    <para>
      When a suspend failure occurs you may get this following warning.
      The most common reason for this notification is that the current user does
      not have permission to suspend or hibernate the computer.
    </para>
    <figure>
      <title>&app; Notification when suspend failure occurs</title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpm-suspend-problem.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
  </section>
</section>

<section id="preferences">
  <title>Preferences</title>

  <para>The preferences window allows you to control:</para>

  <itemizedlist>
    <listitem>
      <para>
        The LCD brightness when on AC and battery power
      </para>
    </listitem>
    <listitem>
      <para>
        The idle time for the screen power-down and suspend action
      </para>
    </listitem>
    <listitem>
      <para>
        The actions to perform when the laptop lid is closed
      </para>
    </listitem>
    <listitem>
      <para>
        The notification area icon policy
      </para>
    </listitem>
  </itemizedlist>

  <note>
    <para>
      Some sliders or option boxes may be disabled if the gconf policy keys are
      not writable.
      This allows administrators to lock-down the actions that a user can select.
    </para>
  </note>

  <section id="preferences-ac">
    <title>AC Power Preferences</title>
    <figure id="prefs-ac">
      <title>&app; AC Power Tab</title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpm-prefs-ac.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
  </section>

  <section id="preferences-battery">
    <title>Battery Power Preferences</title>
    <figure id="prefs-battery">
      <title>&app; Battery Power Tab</title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpm-prefs-battery.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
  </section>

  <section id="preferences-options">
    <title>Preference Options</title>
    <figure id="prefs-options">
      <title>&app; Options Tab</title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpm-prefs-options.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
  </section>

  <section id="preferences-idletimes">
    <title>Session and system idle times</title>

    <para>
      <command>gnome-screensaver</command> is a session daemon that monitors user
      input, and if the mouse has not been moved, or the keyboard been pressed then
      it starts a timeout.
      When the value of this timeout reaches the value set in
      <command>gnome-screensaver-preferences</command>, then the login is marked
      as 'session idle'.
      This is when &application; performs all the session idle actions such as
      enabling low-power mode and lowering the laptop panel brightness.
    </para>

    <figure>
      <title>
      Changing the session idle timout in <command>gnome-screensaver-preferences</command>
      </title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gs-prefs.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>

    <para>
      As soon as the session is marked at idle, &application; starts it's own
      'system' timer.
      When the timeout set in <command>gnome-power-preferences</command> is reached,
      <emphasis>and</emphasis> the CPU load is idle, then the idle action is
      performed, which is usually to turn off the screen, or to suspend or hibernate.
    </para>

    <para>
      To make this clearer, the sliders in <command>gnome-power-preferences</command>
      are set to start at the value of the session-timout + 1 minute, as we cannot
      logically trigger before the session is marked as idle.
      If you adjust the value of the 'session idle' timeout in
      <command>gnome-screensaver-preferences</command> then the start of the sliders
      in <command>gnome-power-preferences</command> will change accordingly.
    </para>
  </section>
</section>

<section id="preferences-advanced">
  <title>Advanced Preferences</title>

  <section id="advanced-preferences-brightness">
    <title>Screen Dim Brightness</title>
    <note>
      <para>
        You can change the idle laptop panel brightness by changing the gconf key
        <command>/apps/gnome-power-manager/laptop_panel_dim_brightness</command>.
      </para>
    </note>
  </section>

  <section id="advanced-preferences-locking">
    <title>Screen Locking</title>
    <para>
      By default, gnome-power-manager supports a simple locking scheme.
      This means that the screen will lock if set to "Lock screen" in
      gnome-screensaver when the lid is closed, or the system performs a suspend or
      hibernate action.
    </para>
    <para>
      There is a complex locking scheme available for power-users that allows
      locking policy to change for the lid, suspend and hibernate actions.
      To enable this complex mode, you will have to disable the gconf key:
    </para>

    <itemizedlist>
      <listitem>
        <para>
          <command>/apps/gnome-power-manager/lock_use_screensaver_settings</command>
        </para>
      </listitem>
    </itemizedlist>

    <para>
      Then the policy keys can be set to force a gnome-screensaver lock and unlock
      when the action is performed:
    </para>

    <itemizedlist>
      <listitem>
        <para>
          <command>/apps/gnome-power-manager/lock_on_blank_screen</command>
        </para>
      </listitem>
      <listitem>
        <para>
          <command>/apps/gnome-power-manager/lock_on_suspend</command>
        </para>
      </listitem>
      <listitem>
        <para>
          <command>/apps/gnome-power-manager/lock_on_hibernate</command>
        </para>
      </listitem>
    </itemizedlist>

    <note>
      <para>
        The lock policy for gnome-screensaver is ignored until the simple mode
        is re-enabled.
      </para>
    </note>
  </section>
</section>

<section id="info">
  <title>Information</title>

  <para>The information window allows you to see:</para>

  <itemizedlist>
    <listitem>
      <para>
        The power devices attached to your system.
      </para>
    </listitem>
    <listitem>
      <para>
        The percentage change graph of your primary device.
      </para>
    </listitem>
    <listitem>
      <para>
        The time remaining change graph of your primary device.
      </para>
    </listitem>
    <listitem>
      <para>
        The charging and discharge rate graph of your primary device.
      </para>
    </listitem>
    <listitem>
      <para>
        The event log of what's happened in the session.
      </para>
    </listitem>
  </itemizedlist>

  <note>
    <para>
      You man not see some options or graphs if your computer does not have the
      required hardware.
      You may also see other hardware not shown here (for example UPS devices)
      but these are treated the same way as other devices.
    </para>
  </note>

  <section id="info-devices">
    <title>Device Information</title>

    <para>
      The device information tab shows the power hardware attached to your system.
      You can click on the "More" expanders for more detailed information about
      your battery device, for instance the design voltage or the capacity
      percentage for a battery.
    </para>

    <figure>
      <title>
        The devices shown on a typical laptop system with a wireless mouse attached
      </title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpm-info-devices.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
  </section>

  <section id="info-charge">
    <title>Charge History</title>

    <para>
      This graph shows the percentage charge available for the composite primary
      battery, so if you have a main laptop battery and an auxiliary battery
      then only the averaged value will be shown.
      A legend is not shown with this graph.
    </para>

    <figure>
      <title>
        The figure shows a typical discharge with two suspend cycles shown as
        horizontal lines.
      </title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpm-info-percentage.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
  </section>

  <section id="info-power">
    <title>Power History</title>

    <para>
      This graph shows the power history charge used by the composite
      primary battery.
      This line represents the amount of power that is either being used to
      charge the batteries in the system, or the power being used by the system
      from the batteries.
      You should see the line go up when processor intensive tasks are
      performed, and down when the system is at idle, or when the screen is
      dimmed.
      A legend is shown with this graph when data events have been received.
    </para>

    <note>
      <para>
        You do will not recieve rate data from your computer if it is not
        charging or discharging, or if the computer is suspended.
        This is due to hardware limitiations where the rate is only sent from
        the battery management chip, rather than the power management chip on
        the motherboard.
      </para>
    </note>

    <figure>
      <title>
        The figure shows part of a typical discharge with two suspend cycles.
      </title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpm-info-rate.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
  </section>

  <section id="info-time">
    <title>Estimated Time History</title>

    <para>
      This graph shows the estimated charge history for the composite primary
      battery.
      This line represents the amount of time required until charged, or the
      amount of time until discharge.
      This line should go proportionally up when the power decreases and down
      when the rate increases.
      A legend is shown with this graph when data events have been received.
    </para>

    <figure>
      <title>
        The figure shows part of a typical discharge with two suspend cycles.
      </title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpm-info-time.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>
  </section>

  <section id="info-eventlog">
    <title>Event Log</title>

    <para>
      The event log is a record of all the actions that gnome-power-manager has
      processed.
      An event might be an dim of the screen, turning on DPMS, or suspending
      due to system inactivity.
    </para>

    <figure>
      <title>
        The event log showing the time, the event and the event description.
      </title>
      <screenshot>
        <mediaobject>
          <imageobject>
            <imagedata fileref="figures/gpm-info-event-log.png" format="PNG"/>
          </imageobject>
        </mediaobject>
      </screenshot>
    </figure>

    <note>
      <para>
        You can clear the event log, or any of the graphs using the "Clear"
        button.
        This permanently removes the data from memory.
      </para>
    </note>
  </section>
</section>

<section id="about">
  <title>About</title>
  <para>
    &app; was written by Richard Hughes <email>richard@hughsie.com</email>.
    To find more information about &app;, please visit the
    <ulink url="http://www.gnome.org/projects/gnome-power-manager" type="http">
    GNOME Power Manager web page</ulink>.
  </para>
  <para>
    To report a bug or make a suggestion regarding this application or
    this manual, follow the directions at the
    <ulink url="http://www.gnome.org/projects/gnome-power-manager/bugs.html" type="http">
    GNOME Power Manager Bug Page</ulink>.
  </para>

  <para>This program is distributed under the terms of the GNU
    General Public license as published by the Free Software
    Foundation; either version 2 of the License, or (at your option)
    any later version. A copy of this license can be found at this
    <ulink url="gnome-power-manager:gpl" type="help">link</ulink>, or in the file
    COPYING included with the source code of this program.
  </para>
</section>

</article>
