Debian Codegraph @

upstream/debian-unstable/man1/xload.1

raw
1 .\"
2 .TH XLOAD 1 "xload 1.1.4" "X Version 11"
3 .SH NAME
4 xload \- system load average display for X
5 .SH SYNOPSIS
6 \fBxload\fP [-\fItoolkitoption\fP ...] [-scale \fIinteger\fP] [-update \fIseconds\fP]
7 .br
8 [-hl \fIcolor\fP] [-highlight \fIcolor\fP] [-remote \fIhost\fP]
9 .br
10 [-jumpscroll \fIpixels\fP] [-label \fIstring\fP] [-nolabel] [-lights]
11 .SH DESCRIPTION
12 The
13 .I xload
14 program displays a periodically updating histogram of the system load average.
15 .SH OPTIONS
16 .PP
17 .I Xload
18 accepts all of the standard X Toolkit command line options (see
19 .BR X (7)).
20 The order of the options is unimportant. xload also accepts the
21 following additional options:
22 .PP
23 .TP 8
24 \fB\-hl\fP \fIcolor\fP or \fB\-highlight\fP \fIcolor\fP
25 This option specifies the color of the scale lines.
26 .TP 8
27 .B \-jumpscroll \fIpixels\fP
28 The number of pixels to shift the graph to the left when the graph
29 reaches the right edge of the window. The default value is 1/2 the width
30 of the current window. Smooth scrolling can be achieved by setting it to 1.
31 .TP 8
32 .B \-label \fIstring\fP
33 The string to put into the label above the load average.
34 .TP 8
35 .B \-nolabel
36 If this command line option is specified then no label will be
37 displayed above the load graph.
38 .TP 8
39 .B \-lights
40 When specified, this option causes
41 .I xload
42 to display the current load average by using the keyboard leds; for
43 a load average of \fIn\fP, xload lights the first \fIn\fP keyboard leds.
44 This option turns off the usual screen display.
45 .TP 8
46 .B \-scale \fIinteger\fP
47 This option specifies the minimum number of tick marks in the histogram,
48 where one division represents one load average point. If the load goes
49 above this number, \fIxload\fP will create more divisions, but it will never
50 use fewer than this number. The default is 1.
51 .PP
52 .TP 8
53 .B \-update \fIseconds\fP
54 This option specifies the interval in seconds at which \fIxload\fP
55 updates its display. The minimum amount of time allowed between updates
56 is 1 second. The default is 10.
57 .TP 8
58 .B \-remote \fIhost\fP
59 This option tells \fIxload\fP to display the load of \fIhost\fP instead of \fIlocalhost\fP. \fIXload\fP gets the information from the \fIrwhod\fP database and consequently requires \fIrwhod\fP to be executing both on \fIlocalhost\fP and \fIhost\fP.
60 .SH RESOURCES
61 In addition to the resources available to each of the widgets used by
62 \fIxload\fP there is one resource defined by the application itself.
63 .TP 8
64 .B showLabel (\fPclass \fIBoolean\fB)
65 If False then no label will be displayed.
66 .SH WIDGETS
67 In order to specify resources, it is useful to know the hierarchy of
68 the widgets which compose \fIxload\fR. In the notation below,
69 indentation indicates hierarchical structure. The widget class name
70 is given first, followed by the widget instance name.
71 .sp
72 .nf
73 XLoad xload
74 Paned paned
75 Label label
76 StripChart load
77 .fi
78 .sp
79 .SH ENVIRONMENT
80 .PP
81 .TP 8
82 .B DISPLAY
83 to get the default host and display number.
84 .TP 8
85 .B XENVIRONMENT
86 to get the name of a resource file that overrides the global resources
87 stored in the RESOURCE_MANAGER property.
88 .SH FILES
89 .TP
90 .I /etc/X11/app-defaults/XLoad
91 specifies required resources
92 .SH SEE ALSO
93 .BR X (7),
94 .BR xrdb (1),
95 .BR mem (4),
96 Athena StripChart Widget.
97 .SH BUGS
98 On older platforms, this program may require the ability to open and read
99 the special system file \fI/dev/kmem\fP. Sites that do not allow general
100 access to this file may need to make \fIxload\fP belong to the same group
101 as \fI/dev/kmem\fP and turn on the \fIset group id\fP permission flag.
102 .PP
103 Reading the load average is inherently non-portable. Therefore, the routine
104 used to read it (get_load.c) must be ported to each new operating system.
105 .SH AUTHORS
106 K. Shane Hartman (MIT-LCS) and Stuart A. Malone (MIT-LCS);
107 .br
108 with features added by Jim Gettys (MIT-Athena), Bob Scheifler (MIT-LCS),
109 Tony Della Fera (MIT-Athena), and Chris Peterson (MIT-LCS).