Debian Codegraph @

upstream/mageia-cauldron/man1/xload.1

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