<?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.0">
  <!ENTITY manrevision "2.0">
  <!ENTITY date "May 2002">
  <!ENTITY applet "Battstat">
]>

<!-- 
      (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>1999</year> 
		<year>2000</year> 
		<holder>Jorgen Pehrson</holder> 
	 </copyright>
	 <copyright>
	        <year>2002</year>
		<holder>Trevor Curtis</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>Jorgen </firstname> 
		  <surname> Pehrson</surname> 
		  <affiliation> 
			 <orgname>GNOME Documentation Project</orgname> 
			 <address> <email>jp@spektr.eu.org</email> </address> 
		  </affiliation> 
		</author> 
		<author>
			<firstname>Trevor</firstname>
			<surname>Curtis</surname>
			<affiliation>
				<orgname>GNOME Documentation Project</orgname>
				<address> <email>tcurtis@somaradio.ca</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>

    <!-- The following feedback information only applies to applets
    listed in bugzilla.gnome.org and bugzilla.ximian.com. For other
    applets, please provide your own feedback info or remove thsi
    section altogether -->
    <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>Battstat Applet</primary> 
  </indexterm> 

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

    <para> The <application>&applet;</application> applet, shown in Figure 1, shows the status of the
      power subsystem in your laptop. To add this applet to your Panel,
      right click on the <guimenuitem>Panel and select Panel->Add to
      panel->Applet->Monitors->Battery Status Utility</guimenuitem>.
    </para>

      <figure id="mainwindow-fig"> 
	<title>&applet; Applet</title> 
	<screenshot> 
	  <mediaobject> 
	    <imageobject><imagedata
		fileref="figures/battstat-applet.png" format="PNG"/> 
	    </imageobject>
	    <!-- EPS versions of the figures are not required at the moment. -->
            <!-- 
		    <imageobject>
      		<imagedata fileref="figures/image.eps" format="EPS"/>
    		    </imageobject>
	    -->
	    <textobject> 
		<phrase>The &applet; Applet.</phrase>
	    </textobject> 
	  </mediaobject> 
	</screenshot> 
      </figure>


</sect1>

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

  <sect1 id="battstat-usage">
    <title>Usage</title>
    <para>&applet; applet requires no user input. You can, if you so
    desire, configure it to some degree as described below. 
    </para>

    <para>  The figure above is shown when the laptop battery is fully
    charged. 
    </para>

    <para> The little flash over the power cord is shown when the laptop
    battery is recharging. It's flashing on and off until the battery is
    fully recharged. 
    </para>

    <para> When you are running your laptop on battery it will display
    this image. 
    </para>

    <para> Right-clicking on the applet brings up a menu containing the
    following items: 
      <variablelist>
	<varlistentry>
	  <term><guimenuitem>Preferences</guimenuitem></term>
	  <listitem>
	    <para>
	      Opens the Properties dialog window.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><guimenuitem>Help</guimenuitem></term>
	  <listitem>
	    <para>
	      Displays this document.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><guimenuitem>About</guimenuitem></term>
	  <listitem>
	    <para>
	      Shows basic information about this applet.
	    </para>
	  </listitem>
	</varlistentry>
	<varlistentry>
	  <term><guimenuitem>Suspend Computer</guimenuitem></term>
	  <listitem>
	    <para>
	      Executes the command specified in
	      the Preferences dialog. 
	    </para>
	  </listitem>
	</varlistentry>
      </variablelist>
    </para>
  </sect1>

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

  <sect1 id="battstatt-prefs">
    <title>Customization</title>
    <para> You can customize the Battstat applet somewhat by
    right-clicking on it and choose Preferences.... This will bring up
    the preferences dialog window. 
    </para>

      <figure id="general-fig"> 
	<title>&applet; General Preferences</title> 
	<screenshot> 
	  <mediaobject> 
	    <imageobject><imagedata
		fileref="figures/battstat-general.png" format="PNG"/> 
	    </imageobject>
	    <!-- EPS versions of the figures are not required at the moment. -->
            <!-- 
		    <imageobject>
      		<imagedata fileref="figures/image.eps" format="EPS"/>
    		    </imageobject>
	    -->
	    <textobject> 
	      <phrase>General preferences for the &applet; applet.</phrase>
	    </textobject> 
	  </mediaobject> 
	</screenshot> 
      </figure>


    <para>The properties are:
    
      <itemizedlist>
	<listitem>
	  <para>Yellow: sets the battery level where the progress bar will switch
	    from green to yellow. Default: 40. 
	  </para>
	</listitem>
        <listitem>
	  <para>Orange: sets the battery level where the progress bar
	  will switch from yellow to orange. Default: 25. 
	  </para>
	</listitem>
	<listitem>
	  <para>Red: sets the battery level where the progress bar will
	  switch from orange to red. Default: 15. 
	  </para>
	</listitem>
	<listitem>
	  <para>The preview frame contains the battery progress bar and
	  a draggable slider. By dragging the slider you can preview how
	  it will look when the battery level actually changes. It
	  doesn't affect the battery in any way. 
	  </para>
	</listitem>
	<listitem>
	  <para>Notify me when battery charge is low: By selecting this,
	  a warning dialog will appear when the power falls below the
	  value in the Red entry box. 
	  </para>
	</listitem>
	<listitem>
	  <para>Notify me when battery is fully re-charged: By selecting
	  this, a dialog window will appear when the battery is fully
	  re-charged. 
	  </para>
	</listitem>
	<listitem>
	  <para>Beep when either of the above is true: If you select
	  this, your laptop will make an audible beep when any of the
	  two above happens. 
	  </para>
	</listitem>
	<listitem>
	  <para>Suspend command: Whatever you enter here will be
	  executed when you click on the Suspend Computer in the applet
	  menu. For example, if you are using FreeBSD
	  you could enter apm -z or zzz here. Before you enter anything
	  though, first make sure that you can safely suspend your
	  laptop by testing the command in a shell. 
	  </para>
	</listitem>
      </itemizedlist>
    </para>

      <figure id="apperance-fig"> 
	<title>&applet; Apperance Preferences</title> 
	<screenshot> 
	  <mediaobject> 
	    <imageobject><imagedata
		fileref="figures/battstat-apperance.png" format="PNG"/> 
	    </imageobject>
	    <!-- EPS versions of the figures are not required at the moment. -->
            <!-- 
		    <imageobject>
      		<imagedata fileref="figures/image.eps" format="EPS"/>
    		    </imageobject>
	    -->
	    <textobject> 
	      <phrase>Apperance preferences for the &applet; applet.</phrase>
	    </textobject> 
	  </mediaobject> 
	</screenshot> 
      </figure>


      <para>The properties on this page are:
        <variablelist>
	  <varlistentry>
	    <term>Move towards top:</term>
	    <listitem>
	      <para>If you select this radio button, the battery charge
	      level meter will drain from right to left. 
	      </para>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
	    <term>Move towards bottom:</term>
	    <listitem>
	      <para>If you select this radio button, the battery charge
	      level meter will drain from left to right 
	      </para>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
	    <term>Applet Layout:</term>
	    <listitem>
	      <para>Here you can select which parts of the applets you
	      want to have visible. 
	      </para>
	    </listitem>
	  </varlistentry>
	</variablelist>
      </para>
    
  </sect1>
  
<!-- This section contains info about the program (not docs), such as
     author's name(s), web page, license, feedback address. This
     section is optional: primary place for this info is "About.." box of
     the program. However, if you do wish to include this info in the
     manual, this is the place to put it. Alternatively, you can put this 
     information in the title page.-->

<sect1 id="battstat-about">
  <title>About &applet;</title>

    <!-- The following feedback information only applies to applets
    listed in bugzilla.gnome.org and bugzilla.ximian.com. For other
    applets, please provide your own feedback info or remove thsi
    section altogether -->
 
     <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> 

  <!-- For translations: uncomment this:

  <para>
   Latin translation was done by ME
   (<email>MYNAME@MYADDRESS</email>). Please send all  comments  and
   suggestions regarding this translation to SOMEWHERE.
  </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
      type="help" url="ghelp:gpl">link</ulink>, or in the file COPYING
      included with the source code of this program. 
   </para>
   </sect1> 

</article> 
