xosview(1x) · carta

NAME

xosview - X based system monitor

SYNOPSIS

xosview [options]

DESCRIPTION

xosview is a monitor which displays the status of several system based parameters. These include CPU usage, load average, memory usage, swap space usage, network usage, interrupts, and serial port status. Each of these is displayed as a horizontal bar which is separated into color coded regions. Each region represents a percentage of the resource which is being put to a particular use. Typing a 'q' in the window will terminate xosview.

At the moment xosview runs on six platforms (Linux, NetBSD, FreeBSD, OpenBSD, some Solaris systems, and HPUX). Not all of the meters described below are supported on all platforms. Some of the meters may appear different depending upon the platform xosview is running on. Note that *BSD is used as an abbreviation for all three of the free BSD operating systems (NetBSD, FreeBSD, OpenBSD).

Load
all platforms : load

Swap Usage
all platforms: used | free

Disk Usage (bytes/sec)
Linux : in | out | idle
*BSD : transferred | idle
HPUX : < Not Supported >

Page Swapping from/to disk
all platforms : in | out | idle

NET Usage
bytes/sec
Linux : in | out | idle
*BSD : in | out | idle
HPUX : < Not Supported >

Interrupts
"leds" which blink when an interrupt occurs.
Linux : IRQs 0 - 15
*BSD : IRQs 0 - 15 (or fewer, depending on architecture)
HPUX : < Not Supported >

Interrupt rate
interrupts per second
Linux : < Not Supported >
*BSD : interrupts | free
HPUX : < Not Supported >

Serial Port Status
"leds" which show the serial port parameters.
Linux : Both the Line Status Register
(LSR) and Modem Status Register
(MSR) are displayed.
*BSD : < Not Supported >
HPUX : < Not Supported >

Battery Level
Shows the current condition of the
battery (for laptops).
Linux : %left | %used
NetBSD : %left | %used
FreeBSD: < Not Supported >
OpenBSD: < Not Supported >
HPUX : < Not Supported >

OPTIONS

Most of these command line options are just a convenient way to set one or more of xosview's resources. Please see the RESOURCES section for more details on what the resource is for.

-v: Displays the version number.

-name name: Sets the Resource name xosview will use (same as the -name option for typical X applications like xterm). When performing resource lookups, xosview will look under name, and then under ``xosview''. For an example, perform the following (as documented in README.netbsd):

xrdb -merge Xdefaults.stipple
xosview -name xosvstipple &
xosview -name xosvstipplebw &

-display display: Sets the X display to display. This option overrides the xosview*display resource.

-font font: Specifies the font xosview will use for labels. This option overrides the xosview*font resource.

-title title: This option sets the name xosview will tell the window manager to use for the X window and icon. This option overrides the xosview*title resource.

-geometry geometry_string: Sets the X geometry to geometry_string. This option overrides the xosview*geometry resource.

-captions: This option overrides the xosview*captions resource. It is equivalent to setting xosview*captions to "False".

+captions

This option overrides the xosview*captions resource. It is equivalent to setting xosview*captions to "True".

-labels: This option overrides the xosview*labels resource. It is equivalent to setting xosview*labels to "False".

+labels

This option overrides the xosview*labels resource. It is equivalent to setting xosview*labels to "True".

-usedlabels: This option overrides the xosview*usedlabels resource. It is equivalent to setting xosview*usedlabels to "False".

+usedlabels

This option overrides the xosview*usedlabels resource. It is equivalent to setting xosview*usedlabels to "True".

-cpu: This option overrides the xosview*cpu resource. It is equivalent to setting xosview*cpu to "False".

+cpu

This option overrides the xosview*cpu resource. It is equivalent to setting xosview*cpu to "True".

-load: This option overrides the xosview*load resource. It is equivalent to setting xosview*load to "False".

+load

This option overrides the xosview*load resource. It is equivalent to setting xosview*load to "True".

-mem: This option overrides the xosview*mem resource. It is equivalent to setting xosview*mem to "False".

+mem

This option overrides the xosview*mem resource. It is equivalent to setting xosview*mem to "True".

-swap: This option overrides the xosview*swap resource. It is equivalent to setting xosview*swap to "False".

+swap

This option overrides the xosview*swap resource. It is equivalent to setting xosview*swap to "True".

-battery: This option overrides the xosview*battery resource. It is equivalent to setting xosview*battery to "False".

+battery

This option overrides the xosview*battery resource. It is equivalent to setting xosview*battery to "True".

-net: This option overrides the xosview*net resource. It is equivalent to setting xosview*net to "False".

+net

This option overrides the xosview*net resource. It is equivalent to setting xosview*net to "True".

-network maxbandwidth

-networkBW maxbandwidth

-networkBandWidth maxbandwidth: These options override the xosview*networkBandwidth resource. They cause xosview to display a meter that will shows network usage, with a maximum bandwidth of maxbandwidth. Notice that setting the bandwidth to 0 no longer disables the meter -- use the ``-net'' option instead.

-page: This option overrides the xosview*page resource. It is equivalent to setting xosview*page to "False".

+page

This option overrides the xosview*page resource. It is equivalent to setting xosview*page to "True".

-pagespeed val: This option overrides the xosview*pageBandWidth resource. The resource xosview*pageBandWidth will be set to val.

-disk: This option overrides the xosview*disk resource. It is equivalent to setting xosview*disk to "False".

+disk

This option overrides the xosview*disk resource. It is equivalent to setting xosview*disk to "True".

-int: This option overrides the xosview*int resource. It is equivalent to setting xosview*int to "False".

+int

This option overrides the xosview*int resource. It is equivalent to setting xosview*int to "True".

-ints +ints

-interrupts +interrupts: Equivalent to -int and +int.

-irqrate: This option overrides the xosview*irqrate resource. It is equivalent to setting xosview*irqrate to "False".

+irqrate

This option overrides the xosview*irqrate resource. It is equivalent to setting xosview*irqrate to "True".

-intrate +intrate: Equivalent to -irqrate and +irqrate.

-xrm resource_string: This switch allows any of xosview's resources to be set on the command line. An example of how the xosview*memFreeColor could be set using this option is shown below (Note the use of " to prevent the shell from expanding ´*´ or from creating two separate arguments, ´xosview*memfreeColor:´ and ´purple´):

-xrm "xosview*memFreeColor: purple"

X RESOURCES

The following is a list of X resources supported by xosview. Each has a default value assigned to it. These values can be found in the file Xdefaults which can be obtained in the source distribution of xosview. They can be overridden in the usual places (/usr/lib/X11/app-defaults/XOsview, $HOME/.Xdefaults, etc.).

It should be noted that it is OK to have a resource defined for a port of xosview that does not support the feature the resource configures. Xosview will simply ignore the resources that are set for it but not supported on a given platform.

General Resources

xosview*title: name

The string that xosview will use for the X window title. Normally xosview will use 'xosview@machine_name' for a title. This resource overrides the default behavior.

xosview*geometry: geometry_string

This is a standard X geometry string that defines the size and location of the X window used by xosview.

xosview*display: name

The name of the display where xosview will contact the X server for drawing its window.

xosview*pixmapName: name

The filename of an X pixmap (xpm) file for use as a background image.

xosview*captions: (True or False)

If True then xosview will display meter captions.

xosview*labels: (True or False)

If True then xosview will display meter labels.

xosview*meterLabelColor: color

The color to use for the meter labels.

xosview*usedlabels: (True or False)

If True then xosview will display labels that show the percentage of the resource (or absolute amount, depending on the meter) being used. This option requires that the labels option also be set to True.

xosview*usedLabelColor: color

The color to use for "used" labels.

xosview*borderwidth: width

The width of the border for the xosview window.

xosview*font: font

This is the font that xosview will use.

xosview*background: color

This is the color that will be used for the background.

xosview*foreground: color

This is the color that will be used for the foreground.

xosview*enableStipple: (True or False)

Change to true to try stipple support. This is primarily for users stuck with 1-bit monitors/display cards. Try setting enableStipple true. Please give us feedback on this, if you use it. It needs some more work, but no one has given us any feedback so far.

xosview*graphNumCols: number

This defines the number of sample bars drawn when a meter is in scrolling graph mode. This also has the side-effect of defining the width of the graph columns. This is only used by meters which have graph mode enabled.

Load Meter Resources

xosview*load: (True or False)

If True then xosview will display a load meter.

xosview*loadWarnColor: color

This is the color that the load meter will use once the load average is greater than 1.

xosview*loadProcColor: color

This is the color that the load meter will use to display the load average when it is less than or equal to 1.

xosview*loadIdleColor: color

The load meter will use this color to display the idle field.

xosview*loadPriority: priority

This number (which must be an integer >= 1) sets the number of tenths of a second that the load meter waits between updates. A value of 1 has xosview update the meter 10 times per second (the fastest). A value of 600 would cause xosview to update the meter once a minute.

xosview*loadAlarmThreshold: int

This number (which must be an integer >= 1) sets the value at which the loadmeter changes its status and color from "normal" to "alarm". The default value is 2.

xosview*loadDecay: (True or False)

You should probably leave this at the default value (False). The load is already a time-averaged value!

xosview*loadGraph: (True or False)

If this is set to True then the load meter will be drawn as a horizontally scrolling bargraph showing the state value verses time.

xosview*loadUsedFormat: (float, percent or autoscale)

This resource tells xosview how to display "used" labels. The formats work as follows:

float:

Display the value as a floating point number.

percent:

Display the value as a percentage of the total.

autoscale:

Display the absolute value and automatically print the units (K, M, or G) as appropriate.

CPU Meter Resources

xosview*cpu: (True or False)

If True then xosview will display a cpu meter. On linux SMP machines this will cause a seperate meter to be displayed for each cpu if Jerome Forissier's kernel patch has been applied. See the 'README.linux' file for more details.

xosview*cpuUserColor: color

The cpu meter will use this color to display the cpu user time field.

xosview*cpuNiceColor: color

The cpu meter will use this color to display the cpu nice time field.

xosview*cpuSystemColor: color

The cpu meter will use this color to display the cpu system time field.

xosview*cpuInterruptColor: color

The cpu meter will use this color to display the cpu interrupt time field.

xosview*cpuFreeColor: color

The cpu meter will use this color to display the cpu idle time field.

xosview*cpuPriority: priority

This number (which must be an integer >= 1) sets the number of tenths of a second that the cpu meter waits between updates. A value of 1 has xosview update the meter 10 times per second (the fastest). A value of 600 would cause xosview to update the meter once a minute.

xosview*cpuDecay: (True or False)

If True then the cpu meter will be split vertically in two. The top half will show the instantaneous state, while the bottom half will display a decaying average of the state.

xosview*cpuGraph: (True or False)

If this is set to True then the cpu meter will be drawn as a horizontally scrolling bargraph showing the state value verses time.

xosview*cpuUsedFormat: (float, percent or autoscale)

This resource tells xosview how to display "used" labels. The formats work as follows:

float:

Display the value as a floating point number.

percent:

Display the value as a percentage of the total.

autoscale:

Display the absolute value and automatically print the units (K, M, or G) as appropriate.

Memory Meter Resources

xosview*mem: (True or False)

If True then xosview will display a mem meter.

xosview*memUsedColor: color

The mem meter will use this color to display the used memory field.

xosview*memSharedColor: color

The mem meter will use this color to display the shared memory field.

xosview*memBufferColor: color

The mem meter will use this color to display the buffer memory field.

xosview*memCacheColor: color

The mem meter will use this color to display the cache memory field.

xosview*memFreeColor: color

The mem meter will use this color to display the free memory field.

xosview*memSharedColor: color

The mem meter will use this color to display the shared memory field.

xosview*memTextColor: color

The mem meter will use this color to display the HP text memory field.

xosview*memOtherColor: color

The mem meter will use this color to display the HP ``other'' memory field.

xosview*memActiveColor: color

The mem meter will use this color to display the NetBSD active memory field.

xosview*memInactiveColor: color

The mem meter will use this color to display the NetBSD inactive memory field.

xosview*memPriority: priority

This number (which must be an integer >= 1) sets the number of tenths of a second that the mem meter waits between updates. A value of 1 has xosview update the meter 10 times per second (the fastest). A value of 600 would cause xosview to update the meter once a minute.

xosview*memDecay: (True or False)

If True then the mem meter will be split vertically in two. The top half will show the instantaneous state, while the bottom half will display a decaying average of the state.

xosview*memGraph: (True or False)

If this is set to True then the mem meter will be drawn as a horizontally scrolling bargraph showing the state value verses time.

xosview*memUsedFormat: (float, percent or autoscale)

This resource tells xosview how to display "used" labels. The formats work as follows:

float:

Display the value as a floating point number.

percent:

Display the value as a percentage of the total.

autoscale:

Display the absolute value and automatically print the units (K, M, or G) as appropriate.

Swap Meter Resources

xosview*swap: (True or False)

If True then xosview will display a swap meter.

xosview*swapUsedColor: color

The swap meter will use this color to display the used swap field.

xosview*swapFreeColor: color

The swap meter will use this color to display the free swap field.

xosview*swapPriority: priority

This number (which must be an integer >= 1) sets the number of tenths of a second that the swap meter waits between updates. A value of 1 has xosview update the meter 10 times per second (the fastest). A value of 600 would cause xosview to update the meter once a minute.

xosview*swapDecay: (True or False)

If True then the swap meter will be split vertically in two. The top half will show the instantaneous state, while the bottom half will display a decaying average of the state.

xosview*swapGraph: (True or False)

If this is set to True then the swap meter will be drawn as a horizontally scrolling bargraph showing the state value verses time.

xosview*swapUsedFormat: (float, percent or autoscale)

This resource tells xosview how to display "used" labels. The formats work as follows:

float:

Display the value as a floating point number.

percent:

Display the value as a percentage of the total.

autoscale:

Display the absolute value and automatically print the units (K, M, or G) as appropriate.

Page Swapping Meter Resources

xosview*page: (True or False)

If True then xosview will display a page meter.

xosview*pageBandWidth: maxEvents

This number is used to specify the expected maximum bandwidth (in events / sec) for the page meter. When the expected maximum bandwidth (maxEvents) is exceeded then the page meter will display the relative percentage of page swapping (25% in, 75% out).

xosview*pageInColor: color

The page meter will use this color to display the page-in field.

xosview*pageOutColor: color

The page meter will use this color to display the page-out field.

xosview*pageIdleColor: color

The page meter will use this color to display the idle field.

xosview*pagePriority: priority

This number (which must be an integer >= 1) sets the number of tenths of a second that the page meter waits between updates. A value of 1 has xosview update the meter 10 times per second (the fastest). A value of 600 would cause xosview to update the meter once a minute.

xosview*pageDecay: (True or False)

If True then the page meter will be split vertically in two. The top half will show the instantaneous state, while the bottom half will display a decaying average of the state.

xosview*pageGraph: (True or False)

If this is set to True then the page meter will be drawn as a horizontally scrolling bargraph showing the state value verses time.

xosview*pageUsedFormat: (float, percent or autoscale)

This resource tells xosview how to display "used" labels. The formats work as follows:

float:

Display the value as a floating point number.

percent:

Display the value as a percentage of the total.

autoscale:

Display the absolute value and automatically print the units (K, M, or G) as appropriate.

Network Meter Resources

xosview*net: (True or False)

If True xosview will display the NetMeter. Linux users will have to configure their kernels and setup some ip accounting rules to make this work. See the file README.linux which comes with the xosview distribution for details.

xosview*netBandwidth: maxBytes

This number is used to specify the expected maximum bandwidth (in bytes / sec) for the meter. When the expected maximum bandwidth (maxBytes) is exceeded then the network meter will display the relative percentage of network usage (25% incomming, 75% outgoing).

xosview*netInColor: color

The net meter will use this color to display the incoming field.

xosview*netOutColor: color

The net meter will use this color to display the outgoing field.

xosview*netBackground: color

This is the color that the network meter will use for the "idle" field.

xosview*netPriority: priority

This number (which must be an integer >= 1) sets the number of tenths of a second that the net meter waits between updates. A value of 1 has xosview update the meter 10 times per second (the fastest). A value of 600 would cause xosview to update the meter once a minute.

xosview*netDecay: (True or False)

If True then the net meter will be split vertically in two. The top half will show the instantaneous state, while the bottom half will display a decaying average of the state.

xosview*netGraph: (True or False)

If this is set to True then the net meter will be drawn as a horizontally scrolling bargraph showing the state value verses time.

xosview*netUsedFormat: (float, percent or autoscale)

This resource tells xosview how to display "used" labels. The formats work as follows:

float:

Display the value as a floating point number.

percent:

Display the value as a percentage of the total.

autoscale:

Display the absolute value and automatically print the units (K, M, or G) as appropriate.

Serial Meter Resources

xosview*serial(0-9): (True, False, or portBase)

If True then xosview will display a serial meter for ttySx. The portbase will be autodetected. Because autodetection can fail, (if the port is locked by ppp/slip for example) you can specify the portbase instead of "True". If a portBase is used then xosview will use it instead of trying to autodetect.

For this to work on Linux xosview needs to be suid root in order to have access to the ports. See the file README.linux which comes with the xosview distribution for more details.

xosview*serialOnColor: color

This is the color the serial meter will use for bits that are set.

xosview*serialOffColor: color

This is the color the serial meter will use for bits that are not set.

xosview*serialPriority: priority

This number (which must be an integer >= 1) sets the number of tenths of a second that the serial meter waits between updates. A value of 1 has xosview update the meter 10 times per second (the fastest). A value of 600 would cause xosview to update the meter once a minute.

Interrupt Meter Resources

xosview*interrupts: (True or False)

If True then xosview will display an interrupt meter.

xosview*intOnColor: color

This is the color that will be used to show "active" interrupts.

xosview*intOffColor: color

This is the color that will be used to show "inactive" interrupts.

xosview*intPriority: priority

This number (which must be an integer >= 1) sets the number of tenths of a second that the int meter waits between updates. A value of 1 has xosview update the meter 10 times per second (the fastest). A value of 600 would cause xosview to update the meter once a minute.

Battery Meter Resources

xosview*battery: (True or False)

If True then xosview will display a battery meter. Linux users will need to have APM support in their kernels for this to work. See the file README.linux which comes with the xosview distribution for more details.

xosview*batteryLeftColor: color

This is the color that will be used to show the amount of battery power left.

xosview*batteryUsedColor: color

This is the color that will be used to show the amount of battery power used.

xosview*batteryPriority: priority

This number (which must be an integer >= 1) sets the number of tenths of a second that the battery meter waits between updates. A value of 1 has xosview update the meter 10 times per second (the fastest). A value of 600 would cause xosview to update the meter once a minute.

xosview*batteryUsedFormat: (float, percent or autoscale)

This resource tells xosview how to display "used" labels. The formats work as follows:

float:

Display the value as a floating point number.

percent:

Display the value as a percentage of the total.

autoscale:

Display the absolute value and automatically print the units (K, M, or G) as appropriate.

Disk Meter Resources

xosview*disk: (True or False)

If True then xosview will display a disk meter.

xosview*diskUsedColor: color

The disk meter will use this color to display the bytes transferred (in or out) field.

xosview*diskIdleColor: color

The disk meter will use this color to display the idle field.

xosview*diskBandwidth: bandwidth

This number is used to specify the expected maximum bandwidth in bytes per second for the disk meter.

xosview*diskWriteColor: color

This color will be used for the linux meter to show writes.

xosview*diskReadColor: color

This color will be used for the linux meter to show reads.

xosview*diskPriority: priority

This number (which must be an integer >= 1) sets the number of tenths of a second that the disk meter waits between updates. A value of 1 has xosview update the meter 10 times per second (the fastest). A value of 600 would cause xosview to update the meter once a minute.

xosview*diskDecay: (True or False)

If True then the disk meter will be split vertically in two. The top half will show the instantaneous state, while the bottom half will display a decaying average of the state.

xosview*diskGraph: (True or False)

If this is set to True then the disk meter will be drawn as a horizontally scrolling bargraph showing the state value verses time.

xosview*diskUsedFormat: (float, percent or autoscale)

This resource tells xosview how to display "used" labels. The formats work as follows:

float:

Display the value as a floating point number.

percent:

Display the value as a percentage of the total.

autoscale:

Display the absolute value and automatically print the units (K, M, or G) as appropriate.

BUGS

Here is a list of known bugs in xosview-1.6.2.a. Reports of unknown bugs are appreciated and should be directed to:

Mike Romberg ([email protected])

General xosview bugs and bugs related to the Linux and HPUX ports.

Brian Grayson ([email protected])

Bugs related to the NetBSD port. I am also a catch-all for bug reports for the other *BSDs and SunOS.

Occasionally (and unrepeatably?), the NetBSD xosview will clobber the NET text in the netmeter with horizontal black bars and the used-label numbers. I'm guessing this has something to do with the net numbers reaching some unusual number (like 0 or maximum), but have not been able to pinpoint it further. BCG