XLOAD

Section: User Commands (1)
Updated: Release 6
Index
 

NAME

xload - system load average display for X  

SYNOPSIS

xload [-toolkitoption ...] [-scale integer] [-update seconds] [-hl color] [-highlight color]

     [-jumpscroll pixels] [-label string] [-nolabel] [-lights]

     [-peername string] [-oid string] [-community string]
 

DESCRIPTION

The xload program displays a periodically updating histogram of the system load average.  

OPTIONS

Xload accepts all of the standard X Toolkit command line options (see X(1)). The order of the options in unimportant. xload-snmp also accepts the following additional options:

-hl color or -highlight color
This option specifies the color of the scale lines.
-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.
-label string
The string to put into the label above the load average.
-nolabel
If this command line option is specified then no label will be displayed above the load graph.
-lights
When specified, this option causes xload to display the current load average by using the keyboard leds; for a load average of n, xload lights the first n keyboard leds. This option turns off the usual screen display.
-scale integer
This option specifies the minimum number of tick marks in the histogram, where one division represents one load average point. If the load goes above this number, xload will create more divisions, but it will never use fewer than this number. The default is 1.

-update seconds
This option specifies the interval in seconds at which xload updates its display. The minimum amount of time allowed between updates is 1 second. The default is 10.

-peername string
The name of the SNMP host to query.

-oid string
The SNMP OID to query.

-community string
The name of a file containing the community string needed to retrieve the OID from the host. The community string is kept in a file so that it does not have to appear on the command line. The file may contain any number of comment lines, which start with a '#'. The only other valid record type is the community string on a line by itself. The community string should not exceed 256 characters.

-factor float
An optional scaling factor. -factor is currently only used when using SNMP. The value returned by each SNMP query is divided by the scaling factor before being plotted on the histogram. Use -factor to scale down very large values and keep the histogram legible. You can also scale up by specifying a factor of less than 1. A factor of zero is not allowed.

-delta
Instead of plotting the actual values plot the difference between the current value and the previous value. This is useful for plotting rates of change using a counter which normally only increases. Currently this option only works when using SNMP.
 

RESOURCES

In addition to the resources available to each of the widgets used by xload there are resources defined by the application itself.
showLabel (class Boolean)
If False then no label will be displayed.
 

WIDGETS

In order to specify resources, it is useful to know the hierarchy of the widgets which compose xload. In the notation below, indentation indicates hierarchical structure. The widget class name is given first, followed by the widget instance name. 


XLoadSNMP  xload-snmp
     Paned  paned
          Label  label
          StripChart  load

 

ENVIRONMENT

DISPLAY
to get the default host and display number.
XENVIRONMENT
to get the name of a resource file that overrides the global resources stored in the RESOURCE_MANAGER property.
 

FILES

<XRoot>/lib/X11/app-defaults/XLoadSNMP - specifies required resources  

SEE ALSO

X(1), xrdb(1), mem(4), Athena StripChart Widget.  

BUGS

This program requires the ability to open and read the special system file /dev/kmem. Sites that do not allow general access to this file should make xload belong to the same group as /dev/kmem and turn on the set group id permission flag.

Reading /dev/kmem is inherently non-portable. Therefore, the routine used to read it (get_load.c) must be ported to each new operating system.  

COPYRIGHT

Copyright ([,]*) X Consortium
See X(1) for a full statement of rights and permissions.  

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).

 

Index

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
RESOURCES
WIDGETS
ENVIRONMENT
FILES
SEE ALSO
BUGS
COPYRIGHT
AUTHORS
This document was created by man2html, using the manual pages.
Time: 15:14:43 GMT, January 24, 2001