<!-- 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="cpuload-applet">
   <title>The CPU load applet</title> 

   <para> 
     The <application>cpuload_applet</application> is a small monitor
     applet which sits in your panel and tells you how much CPU is
     being used. 
   </para>

   <sect2 id="cpuload-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>

    <figure id="cpuload-applet-fig">
      <title>CPU Load Applet</title>
      <screenshot>
	<screeninfo>CPU Load Applet</screeninfo>
	<graphic format="png" fileref="figures/cpuload-applet" 
	     srccredit="Eric Baudais">
	</graphic>
      </screenshot>
    </figure>

    <para>
      <application>cpuload_applet</application> divides CPU use into
      four sorts:
    </para>
    <variablelist>
     <varlistentry>
      <term>User</term>
      <listitem>
       <para>
         This measures CPU use in "userland": ie, things not talking to 
         the kernel. The default colour for this is yellow.
       </para>
      </listitem>
     </varlistentry>
 
     <varlistentry>
      <term>System</term>
      <listitem>
       <para>
         This measures CPU use that involves the kernel: lots of talking
         between memory and disc, for example. The default colour is pale
         grey.
       </para>
      </listitem>
     </varlistentry>
 
     <varlistentry>
      <term>Nice</term>
      <listitem>
       <para>
         This measures CPU use which is not "nice": running at a high priority.
         The default colour is medium grey. 
       </para>
      </listitem>
     </varlistentry>
 
     <varlistentry>
      <term>Idle</term>
      <listitem>
       <para>
         Idle measures unused CPU capacity. The default colour is black.
       </para>
      </listitem>
     </varlistentry>
    </variablelist>
   </sect2>
 
   <sect2 id="cpuload-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="cpuload-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="cpuload-properties">described below</link> which
         affects only the <application>cpuload_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="cpuload-properties">
    <title>Properties</title>

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

    <para>
      Like several of the monitor applets,
      <application>cpuload_applet</application> has two ways of setting
      preferences. You can make changes that affect any of this group 
      (<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="cpuload-greyed-fig">
      <title>Greyed Out Properties Dialog</title>
      <screenshot>
	<screeninfo>CPU Load Applet Greyed Out Properties Dialog</screeninfo>
	<graphic format="png" fileref="figures/cpuload-applet-greyed" 
	     srccredit="Eric Baudais">
	</graphic>
      </screenshot>
    </figure>

    <para>
      Or you can change just the properties for 
      <application>cpuload_applet</application>. This is useful for when
      you only use <application>cpuload_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="cpuload-properties-fig">
      <title>CPU Load Properties Dialog</title>
      <screenshot>
	<screeninfo>CPU Load Applet Properties Dialog</screeninfo>
	<graphic format="png" fileref="figures/cpuload-applet-properties" 
	     srccredit="Eric Baudais">
	</graphic>
      </screenshot>
    </figure>

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

    <variablelist>
     <varlistentry>
      <term>Colours</term>
      <listitem>
       <para>
         You can alter the colours used for the different forms of 
         CPU usage displayed by clicking on the colour boxes. This
         invokes the GNOME colour wheel.
       </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 highest value is 1,000,000,000
         and the lowest is 1. The default is a more sensible 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>
    </variablelist>
   </sect2>
  
   <sect2 id="cpuload-bugs">
    <title> Known Bugs and Limitations</title>
    <para>
      Resizing and then altering the panel orientation can result in
      intermittent problems, although they now fix themselves after a
      short period.
    </para>
   </sect2>

   <sect2 id="cpuload-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 Gywnne
      (<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>
