summaryrefslogtreecommitdiffstats
path: root/gnome-users-guide/gnome-users-guide-1.4/C/applets/swapload-ug.sgml
blob: 3bfc3fe120c1dd63f3a4ecc65f16f1982445fb99 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
<!-- 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. -->

  <sect2 id="swapload-applet">
   <title>The swap load applet</title> 

   <para> 
     The <application>swapload_applet</application> is a small monitor
     applet which sits in your panel and tells you how much swap space is
     being used. 
   </para>
  
   <para>
     The swap space is a part of the hard drive which is not
     part of the filesystem. When the kernel decides a program in
     memory is not being used a lot but might be required soon, 
     it takes parts of the program out of memory and puts those into the 
     swap space, where it can easily retrieve it. Moving data between
     memory and swap can be slow, so if you are using a lot of your
     swap space, you may find the machine's reaction slows.
   </para>
 
   <sect3 id="swapload-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>Swap Load Applet</title>
      <screenshot>
	<screeninfo>Swap Load Applet</screeninfo>
	<graphic format="png" fileref="figures/swapload-applet" 
	     srccredit="Eric Baudais">
	</graphic>
      </screenshot>
    </figure>

   </sect3>

   <sect3 id="swapload-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="swapload-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="swapload-properties">described below</link> which
         affects only the <application>swapload_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>
   </sect3>
  
   <sect3 id="swapload-properties">
    <title>Properties</title>

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

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

    <para>
      Or you can change just the properties for 
      <application>swapload_applet</application>. This is useful for when
      you only use <application>swapload_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="swapload-properties-fig">
      <title>Swap Load Properties Dialog</title>
      <screenshot>
	<screeninfo>Swap Load Applet Properties Dialog</screeninfo>
	<graphic format="png" fileref="figures/swapload-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 used and free swap space
         that are 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, and 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>
     </variablelist>
   </sect3>
  
   <sect3 id="swapload-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>
   </sect3>

   <sect3 id="swapload-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>

   -->

  </sect3>

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

  <!-- 
   <sect3 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>
  </sect3>
--> 
 </sect2>