File: asmem.man

package info (click to toggle)
asmem 1.9-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 308 kB
  • ctags: 135
  • sloc: ansic: 1,416; sh: 183; makefile: 51
file content (208 lines) | stat: -rw-r--r-- 6,279 bytes parent folder | download | duplicates (2)
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
.TH asmem 1 "21 October 2001" "Version 1.9"
.UC
.SH NAME
\fBasmem\fP \- the AfterStep memory utilization monitor
.SH SYNOPSIS
.B asmem
[-h] [-H] [-V]
        [-iconic] [-withdrawn] [-standout]
        [-used] [-asis] [-free] [-mb]
        [-position \fI[+|-]x[+|-]y\fP]
        [-u \fIupdate rate\fP]
        [-dev \fIdevice\fP]
        [-display \fIdisplay\fP]
        [-bg \fIcolor\fP]
        [-fg \fIcolor\fP]
        [-memory \fIcolor\fP]
        [-buffer \fIcolor\fP]
        [-cache \fIcolor\fP]
        [-swap \fIcolor\fP]
.SH DESCRIPTION
The \fBasmem\fP is a X11 application that acts as
a memory utilization monitor. It shows the current
amount of memory and swap space, the free amounts
of those, and the bars representing graphically the
different types of memory.

The display consists of two areas. The one above shows utilization
of the memory, the one below - the utilization of the swap
space. Each area contains a graphical bar that represents the
percentage of the occupied space. For the memory utilization
there are three bars: user/system memory used, buffer memory
and cache memory. For the swap space only one bar showing the
used space. Above each bar is the total amount of space, below
the bar - the available space in kbytes and percents. If the
memory amount is above 999999 kbytes the displays switches
to Mbytes instead of kbytes.

It is possible to force the display into Mbytes. You can also
ask asmem to display the occupied memory amounts and percentages
rather than those still available.

.SH CONFIGURATION OPTIONS
.IP "-h or -H"
.RS
Prints a short description and usage message.
.RE
.IP "-V"
.RS
Version control. Prints out the version of the program.
.RE
.IP "-position [+|-]x[+|-]y"
.RS
Displays the window at the specified location
on the screen. This works like the standard X Windows
geometry option. (See XParseGeometry (3x)).
.RE
.IP "-iconic"
.RS
Starts the \fBasmem\fP application in the iconized mode.
The icon has the same appearance with the main
window.
When this option is given, the -position refers to
the position of the icon window as well as the main window.
.RE
.IP "-withdrawn"
.RS
Starts the \fBasmem\fP application in the withdrawn mode.
This option is necessary to be able to dock the
\fBasmem\fP in the WindowMaker dock.
When this option is given, the -position refers to
the position of the icon window as well as the main window.
\fBasmem\fP ignores the -iconic option when started
in withdrawn mode.
.RE
.IP "-standout"
.RS
This changes the appearance of the \fBasmem\fP display from
"pushed-in" to "popped-out". The first is the default look.
The "popped-out" applets look much better in WindowMaker's dock
according to some opinions. Give it a try in any case.
.RE
.IP "-used"
.RS
By default \fBasmem\fP displays the amount of memory or swap
space still left unused. This switch tells \fBasmem\fP to
display the amounts of memory and swap space already in use.
This switch affects the percentages displayed in accordance.
.RE
.IP "-asis"
.RS
Uses an alternative number for the display of the free memory.
Or, rather, by default an alternative amount is used. When this
switch is specified, the applet displays the amount of memory
free as reported by the /proc/meminfo. Sometimes this is not
really helpful since the occupied memory includes the file system
cache and the buffers space. When this switch is not specified
\fBasmem\fP will add the cache space and the buffer space to the
amount of the actual free memory since both of those may be
discarded by the OS to free up some memory for the programs.
.RE
.IP "-free"
.RS
Exactly the same as \fB-asis\fP. Provided for backward
compatibility. Obsolete. Do not use. Use \fB-asis\fP instead.
.RE
.IP "-mb"
.RS
Force the display in MBytes instead of kilobytes even if
the numbers would fit into the window.
.RE
.IP "-u <update rate>"
.RS
Changes the polling rate for updating the memory 
utilization information.
The update rate is specified in seconds. The value
of 1 is the minimum. Default value is 1 second.
.RE
.IP "-dev <device>"
.RS
The device that should be polled for the memory utilization
information. On Linux, this defaults to \fI/proc/meminfo\fP
.RE
.IP "-display <name>"
.RS
The name of the display to start the window in.
It works just as X Windows display option.
.RE
.IP "-bg <color>"
.RS
Changes the color of the background of the applet.
Default colour is #303030.
.RE
.IP "-fg <color>"
.RS
Changes the color of the foreground of the applet.
Default colour is #20b2aa.
.RE
.IP "-memory <color>"
.RS
Changes the color of the bar that represents the used
memory amount.
Default colour is #4141d7.
.RE
.IP "-buffer <color>"
.RS
Changes the color of the bar that represents the memory
used for buffers.
Default colour is #aa80aa.
.RE
.IP "-cache <color>"
.RS
Changes the color of the bar that represents the memory
used for caching.
Default colour is #bebebe.
.RE
.IP "-swap <color>"
.RS
Changes the color of the bar that represents the swap
space utilization level.
Default colour is #ffa649.
.RE
.SH INVOCATION
\fBasmem\fP can be called in different ways.  The most 
common invocation is the command line:
.nf

	user@host[1]% asmem -bg blue -fg white &

.fi
Another way to call \fBasmem\fP is from the window manager:
.nf

	*Wharf "asmem" nil Swallow "asmem" asmem &

.fi
This line, when placed in the \fIwharf\fP file in the user's Afterstep
configuration directory will cause \fBasmem\fP to be a
button on the \fBWharf (1)\fP button bar under the \fBafterstep (1)\fP
window manager.

If you run WindowMaker then you should use the "-withdrawn"
option:
.nf

	user@host[1]% asmem -withdrawn -standout &

.fi
and then drag the icon to the dock.
.SH BUGS
My programs do not have bugs, they just develop random
features ;-)
.PP
Well, there are limitations. All the strings for the
color names, display name, and the geometry have the
length limit of 50 characters (terminating zero included). 
The string copying routine cuts the names that are longer.
.SH "SEE ALSO"
.BR proc (5)
.SH COPYRIGHTS
Copyright (c) 1999-2000  Albert "Tigr" Dorofeev <albert@tigr.net>

Distributed under GNU General Public License v2 ; 
see LICENSE file for more informations.
.SH AUTHORS
Albert "Tigr" Dorofeev <albert@tigr.net>

See the README file for credits.
.sp