<!-- Permission is granted to make and distribute verbatim copies of -->
<!-- this manual provided the copyright notice and this permission -->
<!-- notice are  preserved on all copies. -->
<!-- -->
<!-- Permission is granted to copy and distribute modified versions of -->
<!-- this manual under the conditions for verbatim copying, provided -->
<!-- that the entire resulting derived work is distributed under the -->
<!-- terms of a permission notice identical to this one. -->
<!-- -->
<!-- Permission is granted to copy and distribute translations of this -->
<!-- manual into another language, under the above conditions for -->
<!-- modified versions, except that this permission notice may be -->
<!-- stated in a translation approved by the Foundation. -->

  <sect1 id="loadavg-applet">
   <title>The load average applet</title> 

   <para> 
     The <application>loadavg_applet</application> is a small monitor
     applet which sits in your panel and tells you the current load
     average.  
   </para>
  
   <para>
     The load average of a machine is a rather arbitrary number which
     represents how "busy" your machine is. It is calculated as an 
     average of (very roughly) how many processes there are which are
     either running or are waiting for a wake-up call from the kernel.
     It is very useful for comparing over time with different load 
     averages on your machine, but it is not very useful to compare
     it with other machines. Normally, it is represented as a fraction.

    <figure id="loadavg-applet-fig">
      <title>Load Average Applet</title>
      <screenshot>
	<screeninfo>Load Average Applet</screeninfo>
	<graphic format="png" fileref="figures/loadavg-applet" 
		 srccredit="Eric Baudais">
	</graphic>
      </screenshot>
    </figure>
  </para>
 
   <sect2 id="loadavg-usage">
    <title>Usage</title>
    <para>
      You don't need to do anything to this applet. It will sit and
      run in your panel. Various options to alter its display are
      available. 
    </para>
   </sect2>

   <sect2 id="loadavg-right-click">
    <title>Right-Click Pop-Up Menu Items</title>
    <para> 
      In addition to the standard menu items,
      the right-click pop-up menu has the following items: 
     </para>   

    <variablelist>
     <varlistentry>
      <term>Default Properties...</term>
      <listitem>
       <para>
         This opens the <guilabel>multiload_applet dialogue box</guilabel>
         <link linkend="loadavg-properties">described below</link> which allows 
         you to alter the default properties of this and related monitor 
         applets.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>Properties...</term>
      <listitem>
       <para>
         This opens the <guilabel>multiload_applet dialogue box</guilabel>
         <link linkend="loadavg-properties">described below</link> which
         affects only the <application>loadavg_applet</application>
         properties.
       </para>
      </listitem>
     </varlistentry>

     <varlistentry>
      <term>Run gtop...</term>
      <listitem>
       <para>
         This option will run the <command>gtop</command> which
         starts up the GNOME System Monitor. <application>gtop</application>
         gives a much more detailed look at your system and what's happening
         on it. 
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </sect2>
  
   <sect2 id="loadavg-properties">
    <title>Properties</title>

    <figure id="loadavg-default-fig">
      <title>Default Properties Dialog</title>
      <screenshot>
	<screeninfo>Load Average Applet Default Properties Dialog</screeninfo>
	<graphic format="png" fileref="figures/loadavg-applet-default" 
		 srccredit="Eric Baudais">
	</graphic>
      </screenshot>
    </figure>

    <para>
      Like several of the monitor applets,
      <application>loadavg_applet</application> has two ways of setting
      preferences. You can make changes that affect any of this group of
      applets, 
      (<application>cpuload_applet</application>, <application>memload_applet</application>,
      <application>swapload_applet</application>, <application>netload_applet</application>
      and <application>loadavg_applet</application>) in one large dialogue
      box. This is useful if you run one or more of them. These are the
      settings used by default. They are reached from the
      <guimenuitem>Default Properties...</guimenuitem> menu item.
    </para>

    <figure id="loadavg-greyed-fig">
      <title>Greyed Out Properties Dialog</title>
      <screenshot>
	<screeninfo>Load Average Applet Greyed Out Properties Dialog</screeninfo>
	<graphic format="png" fileref="figures/loadavg-applet-greyed" 
	     srccredit="Eric Baudais">
	</graphic>
      </screenshot>
    </figure>

    <para>
      Or you can change just the properties for 
      <application>loadavg_applet</application>. This is useful for when
      you only use <application>loadavg_applet</application> or want to
      try new combinations out. It is reached from the 
      <guimenuitem>Properties</guimenuitem> menu item.
    </para>
    <note>
     <para>
      If you use the <guimenuitem>Properties...</guimenuitem> menu item
      and edit the preferences for just this applet, you must uncheck
      the <guibutton>Use default properties</guibutton> checkbox before
      you can alter any settings.
     </para>
    </note>

    <figure id="loadavg-properties-fig">
      <title>Load Average Properties Dialog</title>
      <screenshot>
	<screeninfo>Load Average Applet Properties Dialog</screeninfo>
	<graphic format="png" fileref="figures/loadavg-applet-properties" 
	     srccredit="Eric Baudais">
	</graphic>
      </screenshot>
    </figure>

    <para>
      The changes you can make to the properties are four:
    </para>

    <variablelist>
     <varlistentry>
      <term>Colours</term>
      <listitem>
       <para>
         You can alter the colours used for the applet's display
         clicking on the colour boxes. This invokes the GNOME colour wheel.
         The titles are a little misleading. "Used" is the current load 
         average, and "free" is the background colour.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term>Speed</term>
       <listitem>
        <para>
          You can alter the speed that the graph proceeds with this.
          It is measured in milliseconds. The default is 500.
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term>Size</term>
       <listitem>
        <para>
          You can alter the size of the applet with this. It is measured
          in pixels. The default value is 40, and the range is from 1 pixel
          to whatever you like. In a vertical panel, this refers to the
          height. In a horizontal panel, it refers to the width. 
        </para>
       </listitem>
      </varlistentry>

      <varlistentry>
       <term>Maximum</term>
       <listitem>
        <para>
          This is the maximum number in the Y axis (the possible
          maximum load average which the applet will show). The default
          is 10.
        </para>
        <note>
         <para>
           This option is only available from the <guimenuitem>Default
           Properties menu option</guimenuitem>. It does not appear on
           the dialogue box which is started by the
           <guimenuitem>Properties menu option</guimenuitem>.
         </para>
        </note>
       </listitem>
      </varlistentry>
     </variablelist>
   </sect2>
  
   <sect2 id="loadavg-bugs">
    <title> Known Bugs and Limitations</title>
    <para>
      Resizing and then altering the panel orientation can still cause
      intermittent problems, although they now fix themselves after a
      short period.
    </para>
   </sect2>

   <sect2 id="loadavg-authors">
    <title>Authors</title>
    <para>
      This applet was writen by Martin Baulig (<email>martin@home-of-linux.org</email>).
      Please send all comments, suggestions, and bug 
      reports to the <ulink url="http://bugs.gnome.org" type="http">GNOME
      bug tracking database</ulink>. (Instructions for submitting bug
      reports can be found <ulink
      url="http://bugs.gnome.org/Reporting.html" type="http">
      on-line</ulink>. If you are using
      GNOME 1.1 or later, you can also use <application>Bug Report
      Tool</application> (<command>bug-buddy</command>), available in the
      <guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main
      Menu</guimenu>, for submitting bug reports.
    </para>
    <para> 
      This manual was written by Telsa Gwynne
      (<email>telsa@linuxchix.org</email>) and Eric Baudais 
      (<email>baudais@okstate.edu</email>). Please send all comments and
      suggestions regarding this manual to the <ulink type="http"
      url="http://www.gnome.org/gdp">GNOME Documentation Project</ulink> 
      by sending an email to <email>docs@gnome.org</email>. You can also
      submit comments online by using the <ulink type="http"
      url="http://www.gnome.org/gdp/doctable/">GNOME Documentation Status
      Table</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>

   -->

  </sect2>

  <!-- ============= Application License ============================= -->

  <sect2 id="license">
   <title>License</title>
   <para>
    This program is free software; you can redistribute it and/or
    modify it under the terms of the <citetitle>GNU General Public
    License</citetitle> as published by the Free Software Foundation;
    either version 2 of the License, or (at your option) any later
    version.
   </para>
   <para>
    This program is distributed in the hope that it will be useful, but
    WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    <citetitle>GNU General Public License</citetitle> for more details.
   </para>
   <para>
    A copy of the <citetitle>GNU General Public License</citetitle> is
    included as an appendix to the <citetitle>GNOME Users
    Guide</citetitle>.  You may also obtain a copy of the
    <citetitle>GNU General Public License</citetitle> from the Free
    Software Foundation by visiting <ulink type="http"
    url="http://www.fsf.org">their Web site</ulink> or by writing to
    <address>
     Free Software Foundation, Inc.
     <street>59 Temple Place</street> - Suite 330
     <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>
     <country>USA</country>
    </address>
   </para>
  </sect2>
</sect1>


