xmem/xmem.1
2017-03-15 20:26:11 +00:00

125 lines
3.4 KiB
Groff

.TH XMEM 1 "Release 5, X Version 11" "memory display utility"
.SH NAME
xmem \- memory/swap usage display utility for X
.SH SYNOPSIS
.B xmem
.RB [\| \-toolkitoption ... \|]
.RB [\| \-update
.IR seconds \|]
.RB [\| \-hl
.IR color \|]
.RB [\| \-highlight
.IR color \|]
.RB [\| \-jumpscroll
.IR pixels \|]
.RB [\| \-label
.IR string \|]
.RB [\| \-nolabel \|]
.SH DESCRIPTION
The
.B XMEM
program displays the used amount of memory/swap.
.SH OPTIONS
.B XMEM
accepts all of the standard X Toolkit command line options (see X(1)). The order
of the options in unimportant.
.B XMEM
also accepts the following additional options:
.TP
.B \-hl color, \-highlight color
This option specifies the color of the scale lines.
(Xresource: *mem.highlight)
.TP
.B \-jumpscroll number-of-pixels
The number of pixels to shift the graph to the left when the graph reaches the
right edge of the window. The default value is 1/2 the width of the current
window. Smooth scrolling can be achieved by setting it to 1.
(Xresource: *mem.jumpScroll)
.TP
.B \-label string
The string to put into the label in the
.B XMEM
window. (default: hostname alias)
(Xresource: *label.label)
.TP
.B \-nolabel
If this command line option is specified then no label will be displayed above
the memory usage graph.
(Xresource: *showLabel)
.TP
.B \-update seconds
This option specifies the interval in seconds at which
.B XMEM
updates its display. The minimum amount of time allowed between updates is 1
second. The default is 10.
(Xresource: *mem.update)
.TP
.B \-codecolor color
Color for used code and stack memory. The default is blue.
(Xresource: *mem.codecolor)
.TP
.B \-cachedcolor color
Color for cached memory. The default is orange.
(Xresource: *mem.cachedcolor)
.TP
.B \-buffercolor color
Color for buffer memory. See BUGS.
(Xresource: *mem.buffercolor)
.TP
.B \-freecolor color
Color for free memory. The default is green.
(Xresource: *mem.freecolor)
.TP
.B \-swapcolor color
Color for swap memory. The default is red.
(Xresource: *mem.swapcolor)
.SH RESOURCES
In addition to the resources available to each of the widgets used by
.B XMEM
there is one resource defined by the application itself.
.TP
.B showLabel (class Boolean)
If False then no label will be displayed.
.SH WIDGETS
In order to specify resources, it is useful to know the hierarchy of the widgets
which compose
.B XMEM.
In the notation below, indentation indicates hierarchical structure. The widget
class name is given first, followed by the widget instance name.
.sp
.nf
.ta .5i 1.0i 1.5i 2.0i
Xmem xmem
Paned paned
Label label
StripChart load
.fi
.sp
.SH ENVIRONMENT
.PP
.TP
.B DISPLAY
to get the default host and display number.
.TP
.B XENVIRONMENT
to get the name of a resource file that overrides the global resources
stored in the RESOURCE_MANAGER property.
.SH FILES
/etc/X11/app-defaults/XMem - specifies required resources
.SH SEE ALSO
X(1), xrdb(1), mem(4), Athena StripChart Widget.
.SH BUGS
The buffer-memory is always 0. There is no distinction on BSDs.
.SH COPYRIGHT
Copyright 1988, Massachusetts Institute of Technology.
.br
See X(1) for a full statement of rights and permissions.
.SH AUTHORS
K. Shane Hartman (MIT-LCS) and Stuart A. Malone (MIT-LCS);
with features added by Jim Gettys (MIT-Athena), Bob Scheifler (MIT-LCS), Tony
Della Fera (MIT-Athena), and Chris Peterson (MIT-LCS).
.P
Updated 2007/04 by Michelle Konzack <linux4michelle@freenet.de>
.P
Update by Christian Barthel <bch@onfire.org>, 2017/01, OpenBSD support.