<?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 "System 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 Apr 11, 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>2003</year> 
      <year>2004</year> 
      <holder>Chee Bin HOH</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>Chee Bin</firstname> 
	<surname>HOH</surname> 
	<affiliation> 
	  <orgname>GNOME Documentation Project</orgname> 
	  <address> <email>cbhoh@mimos.my</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>System 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>System Monitor Applet Manual V2.0</revnumber> 
	<date>July 2003</date> 
	<revdescription> 
	  <para role="author">Chee Bin HOH
	    <email>cbhoh@mimos.my</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>&applet; Applet</primary> 
  </indexterm> 
  <indexterm zone="index"> 
    <primary>&applet;</primary> 
  </indexterm>

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

      <!-- ==== Figure ============================================= -->
      <figure id="system-monitor-applet-fig"> 
        <title>&applet; Applet</title> 
        <screenshot> 
        <mediaobject> 
          <imageobject><imagedata fileref="figures/system-monitor-applet_window.png"
			format="PNG"/> 
          </imageobject>
 	  <textobject> 
 	    <phrase>Shows &applet; applet. Displays a graph for system CPU load.
            </phrase> 
          </textobject> 
        </mediaobject> 
	</screenshot> 
      </figure> 
      <!-- ==== End of Figure ======================================= -->

      <para>
        The <application>&applet;</application> applet displays
        system load information in graphical format in a panel.
        You can configure <application>&applet;</application> to display 
        the following information for your system:
      </para>
      <itemizedlist>
        <listitem>
          <para>
            Usage of CPU (central processing unit) time
          </para>
        </listitem>
        <listitem>
          <para>
            Memory usage
          </para>
        </listitem>
        <listitem>
          <para>
            Network traffic 
          </para>
        </listitem>
        <listitem>
          <para>
            Usage of swap space 
          </para>
        </listitem>
        <listitem>
          <para>
            Average system load 
          </para>
        </listitem>
      </itemizedlist>

      <sect2 id="multiload-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 ================================ -->
<!-- Use this section to describe how to use the applet to perform the tasks for 
     which the applet is designed. -->
  <sect1 id="multiload-usage"> 
    <title>Usage</title> 

    <sect2 id="multiload-usage-graphs"> 
      <title>To Display Additional Graphs</title> 
      <para>
        For information about how to add graphs for the various monitored resources, 
        see <xref linkend="multiload-prefs"/>.
      </para>
    </sect2>

    <sect2 id="multiload-usage-current"> 
      <title>To Display the Current Usage of a System Resource</title> 
      <para>
        To display the current usage of a system resource, 
        position the mouse pointer over the corresponding graph in the applet.
        A tooltip displays the current usage as a percentage.
      </para>
    </sect2>

    <sect2 id="multiload-usage-colors"> 
      <title>To Change the Colors in a Graph</title>
      <para>
        To change the colors in a graph, perform the following steps:
      </para>
      <orderedlist>
        <listitem>
          <para>
            Right-click on the applet, then choose <guimenuitem>Preferences</guimenuitem>.
          </para>
        </listitem>
        <listitem>
          <para>
            Select the relevant tab in the <guilabel>Colours</guilabel> area of
            the <guilabel>System Monitor Preferences</guilabel> dialog.
          </para>
        </listitem>
        <listitem>
          <para>
            Click on the relevant color selector button in the selected tabbed section.
          </para>
        </listitem>
        <listitem>
          <para>
            On the <guilabel>Pick a Color</guilabel> dialog,
            use the color wheel or spin boxes to choose the line color
            for the selected parameter.
          </para>
        </listitem>
        <listitem>
          <para>
            Click <guibutton>OK</guibutton>.
          </para>
        </listitem>
      </orderedlist>
    </sect2>

    <sect2 id="multiload-usage-extra"> 
      <title>To Display Additional System Monitor Information</title>
      <para>
        To display additional system monitor information, right-click on the applet, 
        then choose <guimenuitem>Open System Monitor</guimenuitem> to start the
        <application>System Monitor</application> application. 
      </para>
      <para>
        The <application>System Monitor</application> application 
        enables you to monitor system processes and usage of system resources.
        You can use the <application>System Monitor</application> application 
        to modify the behavior of your system.
      </para>
    </sect2>

  </sect1>

<!-- ============= Preferences =========================== -->
  <sect1 id="multiload-prefs">
    <title>Preferences</title> 
    <para>
      To configure the <application>&applet;</application> applet, 
      right-click on the applet, then choose <guimenuitem>Preferences</guimenuitem>.
    </para>
    <variablelist>
      <varlistentry>
        <term>Monitored Resources</term>
        <listitem>
          <itemizedlist>
            <listitem>
              <para>
                <guilabel>Processor</guilabel>
              </para>
              <para>
                Select this option to display the graph for CPU usage.
              </para>
            </listitem>
            <listitem>
              <para>
                <guilabel>Memory</guilabel>
              </para>
              <para>
                Select this option to display the graph for memory usage.
              </para>
            </listitem>
            <listitem>
              <para>
                <guilabel>Network</guilabel>
              </para>
              <para>
                Select this option to display the graph for network traffic.
              </para>
            </listitem>
            <listitem>
              <para>
                <guilabel>Swap Space</guilabel>
              </para>
              <para>
                Select this option to display the graph for swap-space usage.
              </para>
            </listitem>
            <listitem>
              <para>
                <guilabel>Load</guilabel>
              </para>
              <para>
                Select this option to display the graph for average system load.
              </para>
            </listitem>
          </itemizedlist>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>Options</term>
        <listitem>
          <itemizedlist>
            <listitem>
              <para>
                <guilabel>System monitor width</guilabel>
              </para>
              <para>
                Use this spin box to specify the width of each 
                <application>&applet;</application> graph.
              </para>
            </listitem>
            <listitem>
              <para>
                <guilabel>System monitor update interval</guilabel>
              </para>
              <para>
                Use this spin box to specify the interval at which 
                you want to update the graphs.
              </para>
            </listitem>
          </itemizedlist>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>Colours</term>
        <listitem>
          <para>
            The tabbed section for each resource provides color selection buttons
            that you can use to change the color of the parameters for each resource.
            For more information about how to use the color section buttons,
            see <xref linkend="multiload-usage-colors"/>.
          </para>
          <itemizedlist>
            <listitem>
              <para>
                <guilabel>Processor</guilabel>
              </para>
              <para>
                Select this tab to display the color buttons for the following parameters:
              </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>Parameter</para></entry>
                      <entry colname="COLSPEC1">
                        <para>Description</para></entry>
                    </row>
                  </thead>
                  <tbody>
                    <row valign="top">
                      <entry><para><guilabel>User</guilabel></para></entry>
                      <entry><para>Processor time used by non-kernel activities</para></entry>
                    </row>
                    <row valign="top">
                      <entry><para><guilabel>System</guilabel></para></entry>
                      <entry><para>Processor time used by kernel activities</para></entry>
                    </row>
                    <row valign="top">
                      <entry><para><guilabel>Nice</guilabel></para></entry>
                      <entry><para>Processor time used by high-priority processes</para></entry>
                    </row>
                    <row valign="top">
                      <entry><para><guilabel>Idle</guilabel></para></entry>
                      <entry><para>Unused processory capacity</para></entry>
                    </row>
                  </tbody>
                </tgroup>
              </informaltable>
            </listitem>
            <listitem>
              <para>
                <guilabel>Memory</guilabel>
              </para>
              <para>
                Select this tab to display the color buttons for the following parameters:
              </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>Parameter</para></entry>
                      <entry colname="COLSPEC1">
                        <para>Description</para></entry>
                    </row>
                  </thead>
                  <tbody>
                    <row valign="top">
                      <entry><para><guilabel>User</guilabel></para></entry>
                      <entry><para>Memory used by non-kernel activities</para></entry>
                    </row>
                    <row valign="top">
                      <entry><para><guilabel>Shared</guilabel></para></entry>
                      <entry><para>Memory used by more than one application</para></entry>
                    </row>
                    <row valign="top">
                      <entry><para><guilabel>Buffers</guilabel></para></entry>
                      <entry><para>Memory used to temporarily store sent or received data</para></entry>
                    </row>
                    <row valign="top">
                      <entry><para><guilabel>Cached</guilabel></para></entry>
                      <entry><para>Memory used to store data for fast access</para></entry>
                    </row>
                    <row valign="top">
                      <entry><para><guilabel>Free</guilabel></para></entry>
                      <entry><para>Memory not currently in use</para></entry>
                    </row>
                  </tbody>
                </tgroup>
              </informaltable>
            </listitem>
            <listitem>
              <para>
                <guilabel>Network</guilabel>
              </para>
              <para>

                Select this tab to display the color buttons for the following parameters:
              </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>Parameter</para></entry>
                      <entry colname="COLSPEC1">
                        <para>Description</para></entry>
                    </row>
                  </thead>
                  <tbody>
                    <row valign="top">
                      <entry><para><guilabel>SLIP</guilabel></para></entry>
                      <entry><para>Serial Line Internet Protocol network connection</para></entry>
                    </row>
                    <row valign="top">
                      <entry><para><guilabel>PLIP</guilabel></para></entry>
                      <entry><para>Parallel Line Internet Protocol network connection</para></entry>
                    </row>
                    <row valign="top">
                      <entry><para><guilabel>Ethernet</guilabel></para></entry>
                      <entry><para>Ethernet network connection</para></entry>
                    </row>
                    <row valign="top">
                      <entry><para><guilabel>Other</guilabel></para></entry>
                      <entry><para>Network connection other than SLIP, PLIP, or Ethernet</para></entry>
                    </row>
                    <row valign="top">
                      <entry><para><guilabel>Background</guilabel></para></entry>
                      <entry><para>No network connection</para></entry>
                    </row>
                  </tbody>
                </tgroup>
              </informaltable>
            </listitem>
            <listitem>
              <para>
                <guilabel>Swap Space</guilabel>
              </para>
              <para>
                Select this tab to display the color buttons for the following parameters:
              </para>
              <itemizedlist>
                <listitem>
                  <para><guilabel>Used</guilabel> swap space</para>
                </listitem>
                <listitem>
                  <para><guilabel>Free</guilabel> swap space</para>
                </listitem>
              </itemizedlist>
            </listitem>
            <listitem>
              <para>
                <guilabel>Load</guilabel>
              </para>
              <para>
                Select this tab to display the color buttons for the following parameters:
              </para>
              <itemizedlist>
                <listitem>
                  <para><guilabel>Average</guilabel> load</para>
                </listitem>
                <listitem>
                  <para><guilabel>Background</guilabel>, that is, no load</para>
                </listitem>
              </itemizedlist>
            </listitem>
          </itemizedlist>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect1>

</article> 
