<?xml version="1.0"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
  <!ENTITY legal SYSTEM "legal.xml">
  <!ENTITY appletversion "2.5.4">
  <!ENTITY manrevision "2.1">
  <!ENTITY date "February 2004">
  <!ENTITY applet "Battery Charge Monitor">
]>

<!-- 
      (Do not remove this comment block.)
  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>&applet; Applet Manual V&manrevision;</title> 
    <copyright>
      <year>2004</year>
      <holder>Sun Microsystems</holder>
    </copyright>
    <copyright>
      <year>2002</year>
      <holder>Trevor Curtis</holder>
    </copyright>
    <copyright> 
      <year>1999</year> 
      <year>2000</year> 
      <holder>Jorgen Pehrson</holder> 
    </copyright>
<!-- translators: uncomment this:

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

   -->

    <publisher> 
      <publishername> GNOME Documentation Project </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>Sun</firstname>
        <surname>GNOME Documentation Team</surname>
        <affiliation><orgname>Sun Microsystems</orgname></affiliation>
      </author>
      <author>
        <firstname>Trevor</firstname>
        <surname>Curtis</surname>
        <affiliation>
          <orgname>GNOME Documentation Project</orgname>
          <address> <email>tcurtis@somaradio.ca</email> </address>
        </affiliation>
      </author>
      <author> 
        <firstname>Jorgen </firstname> 
        <surname> Pehrson</surname> 
        <affiliation> 
          <orgname>GNOME Documentation Project</orgname> 
          <address> <email>jp@spektr.eu.org</email> </address> 
        </affiliation> 
      </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>Battery Charge Monitor Applet Manual V&manrevision;</revnumber>
        <date>&date;</date>
        <revdescription>
          <para role="author">Sun GNOME Documentation Team</para>
          <para role="publisher">GNOME Documentation Project</para>
        </revdescription>
      </revision>
      <revision>
        <revnumber>Battery Charge Monitor Applet Manual V2.0</revnumber>
        <date>May 2002</date>
        <revdescription>
          <para role="author">Trevor Curtis
            <email>tcurtis@somaradio.ca</email>
          </para>
          <para role="author">Jorgen Pehrson
            <email>jp@spektr.eu.org</email>
          </para>
          <para role="publisher">GNOME Documentation Project</para>
        </revdescription>
      </revision>
    </revhistory>
                                                                                                  
    <releaseinfo>This manual describes version &appletversion; of &applet;.
    </releaseinfo>
                                                                                                  
    <legalnotice>
      <title>Feedback</title>
      <para>
        To report a bug or make a suggestion regarding the &applet; applet or
        this manual, follow the directions in the <ulink url="ghelp:gnome-feedback"
        type="help">GNOME Feedback Page</ulink>.
      </para>
    </legalnotice> 
  </articleinfo> 

  <indexterm zone="index"> 
	 <primary>Battery Charge Monitor Applet</primary> 
  </indexterm> 

  <indexterm zone="index"> 
	 <primary>Battstat Applet</primary> 
  </indexterm> 

<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
  <sect1 id="battstat-introduction"> 
    <title>Introduction</title> 

    <figure id="battstat-applet-fig"> 
      <title>&applet; Applet</title> 
      <screenshot> 
        <mediaobject> 
          <imageobject><imagedata
            fileref="figures/battstat-applet_window.png" format="PNG"/> 
          </imageobject>
          <textobject> 
            <phrase>The &applet; applet.</phrase>
          </textobject> 
        </mediaobject> 
      </screenshot> 
    </figure>

    <para>
      The <application>&applet;</application> applet shows the status of the power subsystem in your laptop. You can configure the applet to show the following components in the panel:
    </para>
    <itemizedlist>
      <listitem>
        <para>
          Power connection status 
        </para>
      </listitem>
      <listitem>
        <para>
          Battery status
        </para>
      </listitem>
      <listitem>
        <para>
          Battery charge percentage
        </para>
      </listitem>
    </itemizedlist>

    <sect2 id="battstat-introduction-add">
      <title>To Add &applet; to a Panel</title>
      <para>
        To add <application>&applet;</application> to a panel, right-click on the panel, then choose <menuchoice><guimenu>Add to Panel</guimenu><guisubmenu>Utility</guisubmenu><guimenuitem>&applet;</guimenuitem></menuchoice>.
      </para>
      <para>
        The layout of the <application>&applet;</application> applet varies depending on the size and type of panel in which the applet resides.
      </para>
    </sect2>

</sect1>

<!-- ================ Usage ================================ -->

  <sect1 id="battstat-usage">
    <title>Usage</title>

    <sect2 id="battstat-usage-power">
      <title>To Determine the Power Connection Status</title>
      <para>
        The power connection status shows the current status of the laptop power supply:
      </para>
      <informaltable frame="all">
        <tgroup cols="2" colsep="1" rowsep="1">
          <colspec colname="COLSPEC0" colwidth="50*"/>
          <colspec colname="COLSPEC1" colwidth="50*"/>
          <thead>
            <row valign="top">
              <entry colname="COLSPEC0">
                <para>Icon</para></entry>
              <entry colname="COLSPEC1">
                <para>Power Status</para></entry>
            </row>
          </thead>
          <tbody>
            <row valign="top">
              <entry>
                <para>
                  <inlinemediaobject>
                    <imageobject>
                      <imagedata fileref="figures/ac_small.png" format="PNG"/>
                    </imageobject>
                    <textobject>
                      <phrase>Shows icon for AC power.</phrase>
                    </textobject>
                  </inlinemediaobject>
                </para>
              </entry>
              <entry>
                <para>
                  The laptop is connected to a power supply. 
                </para>
              </entry>
            </row>
            <row valign="top">
              <entry>
                <para>
                  <inlinemediaobject>
                    <imageobject>
                      <imagedata fileref="figures/flash_small.png" format="PNG"/>
                    </imageobject>
                    <textobject>
                      <phrase>Shows icon for battery recharging.</phrase>
                    </textobject>
                  </inlinemediaobject>
                </para>
              </entry>
              <entry>
                <para>
                  The laptop battery is recharging.
                </para>
              </entry>
            </row>
            <row valign="top">
              <entry>
                <para>
                  <inlinemediaobject>
                    <imageobject>
                      <imagedata fileref="figures/battery_small.png" format="PNG"/>
                    </imageobject>
                    <textobject>
                      <phrase>Shows icon for battery power.</phrase>
                    </textobject>
                  </inlinemediaobject>
                </para>
              </entry>
              <entry>
                <para>
                  The laptop is using battery power.
                </para>
              </entry>
            </row>
            <row valign="top">
              <entry>
                <para>
                  <inlinemediaobject>
                    <imageobject>
                      <imagedata fileref="figures/warning_small.png" format="PNG"/>
                    </imageobject>
                    <textobject>
                      <phrase>Shows icon for low power.</phrase>
                    </textobject>
                  </inlinemediaobject>
                </para>
              </entry>
              <entry>
                <para>
                  The laptop power is very low.
                </para>
              </entry>
            </row>
          </tbody>
        </tgroup>
      </informaltable>
    </sect2>

    <sect2 id="battstat-usage-progress">
      <title>To Determine the Battery Status</title>
      <para>
        The battery-status icon is a progress bar within a battery image. The size and color of the progress bar indicate how much charge remains in the battery:
      </para>
      <informaltable frame="all">
        <tgroup cols="2" colsep="1" rowsep="1">
          <colspec colname="COLSPEC0" colwidth="50*"/>
          <colspec colname="COLSPEC1" colwidth="50*"/>
          <thead>
            <row valign="top">
              <entry colname="COLSPEC0">
                <para>Icon</para></entry>
              <entry colname="COLSPEC1">
                <para>Battery Charge Level</para></entry>
            </row>
          </thead>
          <tbody>
            <row valign="top">
              <entry>
                <para>
                  <inlinemediaobject>
                    <imageobject>
                      <imagedata fileref="figures/batt_green.png" format="PNG"/>
                    </imageobject>
                    <textobject>
                      <phrase>Shows icon for high battery-charge level.</phrase>
                    </textobject>
                  </inlinemediaobject>
                </para>
              </entry>
              <entry>
                <para>
                  High
                </para>
              </entry>
            </row>
            <row valign="top">
              <entry>
                <para>
                  <inlinemediaobject>
                    <imageobject>
                      <imagedata fileref="figures/batt_yellow.png" format="PNG"/>
                    </imageobject>
                    <textobject>
                      <phrase>Shows icon for medium battery-charge level.</phrase>
                    </textobject>
                  </inlinemediaobject>
                </para>
              </entry>
              <entry>
                <para>
                  Medium
                </para>
              </entry>
            </row>
            <row valign="top">
              <entry>
                <para>
                  <inlinemediaobject>
                    <imageobject>
                      <imagedata fileref="figures/batt_orange.png" format="PNG"/>
                    </imageobject>
                    <textobject>
                      <phrase>Shows icon for low battery-charge level.</phrase>
                    </textobject>
                  </inlinemediaobject>
                </para>
              </entry>
              <entry>
                <para>
                  Low
                </para>
              </entry>
            </row>
            <row valign="top">
              <entry>
                <para>
                  <inlinemediaobject>
                    <imageobject>
                      <imagedata fileref="figures/batt_red.png" format="PNG"/>
                    </imageobject>
                    <textobject>
                      <phrase>Shows icon for very low battery-charge level.</phrase>
                    </textobject>
                  </inlinemediaobject>
                </para>
              </entry>
              <entry>
                <para>
                  Very low
                </para>
              </entry>
            </row>
          </tbody>
        </tgroup>
      </informaltable>
      <para>
        For information about how to set the battery color levels, see <xref linkend="battstat-prefs-general"/>.
      </para>
      <para>
        For information about how to display the current battery charge as a percentage, see <xref linkend="battstat-prefs-appearance"/>.
      </para>
    </sect2>

    <sect2 id="battstat-usage-suspend">
      <title>To Suspend the Computer</title>
      <para>
        To suspend the computer, right-click on the applet, then choose <guimenuitem>Suspend Computer</guimenuitem>. For information about how to specify which command to run when you choose <guimenuitem>Suspend Computer</guimenuitem>, see <xref linkend="battstatt-prefs"/>.
      </para>
    </sect2>

  </sect1>

  <!-- ============= Customization ============================= -->

  <sect1 id="battstatt-prefs">
    <title>Preferences</title>
    <para>
      To configure the <application>&applet;</application> applet, right-click on the applet, then choose <guimenuitem>Preferences</guimenuitem>. The <guilabel>Battery Charge Monitor Preferences</guilabel> dialog contains the following tabbed sections:
    </para>
    <itemizedlist>
      <listitem>
        <para><xref linkend="battstat-prefs-general"/></para>
      </listitem>
      <listitem>
        <para><xref linkend="battstat-prefs-appearance"/></para>
      </listitem>
    </itemizedlist>
                                                                                                  
    <sect2 id="battstat-prefs-general">
      <title>General</title>
      <variablelist>
        <varlistentry>
          <term><guilabel>Battery Color Levels %</guilabel></term>
          <listitem>
            <itemizedlist>
              <listitem>
                <para>
                  <guilabel>Yellow</guilabel>
                </para>
                <para>
                  Use this spin box to set the battery-charge level at which the progress bar changes from green to yellow.
                </para>
              </listitem>
              <listitem>
                <para>
                  <guilabel>Orange</guilabel>
                </para>
                <para>
                  Use this spin box to set the battery-charge level at which the progress bar changes from yellow to orange.
                </para>
              </listitem>
              <listitem>
                <para>
                  <guilabel>Red</guilabel>
                </para>
                <para>
                  Use this spin box to set the battery-charge level at which the progress bar changes from orange to red.
                </para>
              </listitem>
              <listitem>
                <para>
                  <guilabel>Preview</guilabel>
                </para>
                <para>
                  Move the slider to show how the progress bar changes when the battery-charge level changes.
                </para>
              </listitem>
            </itemizedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><guilabel>Warnings</guilabel></term>
          <listitem>
            <itemizedlist>
              <listitem>
                <para>
                  <guilabel>Warn when battery charge is low</guilabel>
                </para>
                <para>
                  Select this option to display an information alert when the battery-charge level falls below the value specified in the <guilabel>Red</guilabel> spin box.
                </para>
              </listitem>
              <listitem>
                <para>
                  <guilabel>Warn when battery is fully re-charged</guilabel>
                </para>
                <para>
                  Select this option to display an information alert when the battery is fully recharged.
                </para>
              </listitem>
              <listitem>
                <para>
                  <guilabel>Beep when displaying a warning</guilabel>
                </para>
                <para>
                  Select this option to play a beep sound when an information alert is displayed.
                </para>
              </listitem>
            </itemizedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><guilabel>Suspend</guilabel></term>
          <listitem>
            <itemizedlist>
              <listitem>
                <para>
                  <guilabel>Suspend command</guilabel>
                </para>
                <para>
                  Use this text box to specify which command to run when you choose <guimenuitem>Suspend Computer</guimenuitem> from the applet right-click popup menu.
                </para>
              </listitem>
            </itemizedlist>
          </listitem>
        </varlistentry>
      </variablelist>
    </sect2>

    <sect2 id="battstat-prefs-appearance">
      <title>Appearance</title>
      <variablelist>
        <varlistentry>
          <term><guilabel>Layout</guilabel></term>
          <listitem>
            <itemizedlist>
              <listitem>
                <para>
                  <guilabel>Show battery status</guilabel>
                </para>
                <para>
                  Select this option to display the battery status.
                </para>
              </listitem>
              <listitem>
                <para>
                  <guilabel>Show power connection status</guilabel>
                </para>
                <para>
                  Select this option to display the power connection status.
                </para>
              </listitem>
              <listitem>
                <para>
                  <guilabel>Show battery charge percentages</guilabel>
                </para>
                <para>
                  Select this option to display how much charge the battery currently contains, expressed as a percentage.
                </para>
              </listitem>
            </itemizedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><guilabel>Progress Bar Direction</guilabel></term>
          <listitem>
            <itemizedlist>
              <listitem>
                <para>
                  <guilabel>Moves towards top</guilabel>
                </para>
                <para>
                  Select this option to specify that the progress bar decreases from right to left.
                </para>
              </listitem>
              <listitem>
                <para>
                  <guilabel>Moves towards bottom</guilabel>
                </para>
                <para>
                  Select this option to specify that the progress bar decreases from left to right.
                </para>
              </listitem>
            </itemizedlist>
          </listitem>
        </varlistentry>
      </variablelist>
    </sect2>

  </sect1>

</article> 
