xosview2(1)
| XOSVIEW(2.3.4) | XOSVIEW(2.3.4) |
NAME
xosview - X based system monitor
SYNOPSIS
xosview |
[OPTIONS] |
DESCRIPTION
xosview is a program which displays system based parameters. These include CPU usage, load average, memory usage, swap space usage, network usage, interrupts, file system capacity and more. Each parameter is displayed in an X11 window as a horizontal bar graph, scrolling chart or an array of colored bits. The type of graph depends on the nature of the data being displayed and the configuration of xosview.
Typing a 'q' in the window will terminate xosview. If xosview was built with the SM and ICE libraries, then it will communicate with the session manager when asked to do so.
At the moment xosview runs on platforms including (Linux, NetBSD, FreeBSD, OpenBSD, dragonflyBSD, solaris, cygwin, minix and GNU). 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 of the free BSD operating systems.
| Supported Meters | ||||||
| Meter | Linux | *BSD | Gnu | Minix | Solaris | Cygwin |
| Load Average | yes | yes | yes | yes | yes | yes |
| CPU | yes | yes | yes | yes | yes | yes |
| Memory | yes | yes | yes | yes | yes | yes |
| Swap | yes | yes | yes | no | yes | yes |
| Page xfer | yes | yes | yes | no | yes | yes |
| Disk xfer | yes | yes | no | no | yes | yes |
| Filesys | yes | yes | yes | yes | yes | yes |
| Network | yes | yes | yes | no | yes | yes |
| Wifi quality | yes | no | no | no | no | no |
| Interrupt rate | yes | yes | no | no | yes | yes |
| Interrupts | yes | yes | no | no | no | no |
| Temperature | yes | yes | no | no | no | yes |
| Serial | ? | no | no | no | no | no |
| Battery | yes | ? | no | no | no | no |
| RAID | yes | no | no | no | no | no |
| NFS | ? | no | no | no | no | no |
Note: A marker of ? indicates an untested meter. Reports on the status of these are welcome!
OPTIONS
Almost all of these command line options are just a convenient way to set one or more of xosview's resources. All resouces set on the command line will override those specified anywhere else. Please see the RESOURCES section for more details on what the resource is for and for the overall scheme of how resource values are used.
| --help | Displays usage information to stdout and exits. |
| -h | |
| --version | Displays the version information and exits. |
| -v | |
| --display name | Sets the X display to name. |
| -display | |
| --title name | 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. |
| -title | |
| -geometry geometry | Sets the X geometry to geometry_string. This option overrides the xosview*geometry resource. |
| -g | |
| --foreground color | The color to use for the foreground. |
| -fg | |
| --background color | The color to use for the background. |
| -bg | |
| -font fontName | Specifies the fontName xosview will use for labels. This option overrides the xosview*font resource. Not all fonts currently work well with xosview. For more details see the RESOURCES section. |
| -fn | |
| --iconic | Request to start in an iconic state. |
| -iconic | |
| --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''. |
| -name | |
| -xrm spec | 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 | |
| --option spec | This option is exactly the same as -xrm except that you do not need to specify an instance name (such as xosview*). It will be prepended for you. So, this will also set the xosview*memFreeColor to purple: -o "memFreeColor: purple" |
| -o | |
| --config fileName | Load an XResource file. This file will override (not replace) any previous resources. See the RESOURCES section for more details. |
| -c | |
| --xrm-dump | Dump the X resouces seen by xosview to stdout and exit. This will show a final list of all resources seen after loading and merging is finished. |
| -xrmd | |
| --smid sessionID | Starts xosview with the provided sessionID. This option will allow xosview to work with window managers that find the simple XSetWMProperties() method of saving session information uninteresting (looks at KDE). If configured with libSM/libICE xosview will arrange for it's restart in a new session with this argument. There should be no need for a user to use this option. It is documented here for completeness. |
| -smid | |
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. This file is installed in the XAPPLOADDIR ($prefix/share/X11/app-defaults) when xosview is installed.
The resources can be overridden in the usual places used by X applications (XAPPLOADDIR, $HOME/.Xdefaults, etc.). Individual options can be set on the command line of xosview with options such as -xrm and -o and files containing multiple options can be specified with the -c switch.
The default values of many resources are set to enable many of the exsisting features. This allows new users to see that these features exist without having to read the documentation. Most users will probably want to customize the defaults to their own taste by adding a few lines to their
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.
Loading X Resources
The resouces used by xosview are located and loaded in the following order. Each layer overrides the previous. And, of course, the best match is used. For example ".xosview*font" overrides the more generic "*font".
- 1
- An embeded copy of Xdefaults used to build xosview. So, xosview always has a default and complete set of resources even if all other options fail.
- 2
- Standard X11 search paths and mechanics (XAPPLRESDIR, .Xdefault, xmodmap, etc). For full details see the X documentation. The following is a short summary:
- •
- From the class file (XOsview) found in the app-defaults directory configured into xosview at compile time.
- •
- From the class file (XOsview) in the XAPPLRESDIR (environment variable).
- •
- From resources loaded onto the Display of the X server (by xrdb for example).
- •
- From resources loaded onto the Screen of the Display (again by xrdb or the like).
- •
- From the .Xdefaults file in the users HOME (environment variable) directory. Xosview loads this file even if your X session did not.
- •
- From resources found in the file specified by the XENVIRONMENT environment variable.
- 3
- Resource files specified by the -c, --config command line arguments
- 4
- Resources set by using the -xrm command line argument(s).
- 5
- Command line options (such as -display) that set resources.
Note that since xosview always starts off with a complete set of resources it
requires then you only need specify those options you would like to change
from their default values. For example your .Xdefaults file could simply
contain the line "xosview*background: blue" if all you wish is an
"stock" xosview with a blue background.
General Resources
xosview*title: name
xosview*geometry: geometry_string
xosview*display: name
xosview*pixmapName: name
xosview*transparent: (True or False)
xosview*captions: (True or False)
xosview*labels: (True or False)
xosview*meterLabelColor: color
xosview*usedlabels: (True or False)
xosview*usedLabelColor: color
xosview*font: font
xosview*background: color
xosview*foreground: color
xosview*enableStipple: (True or False)
xosview*graphNumCols: number
General Meter Resources
xosview*prefixPriority: value
xosview*prefixUsedFormat: (float, percent or autoscale)
| 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. |
prefixDecay: (True or False)
xosview*prefixUsedDecay: (True or False)
xosview*prefixGraph: (True or False)
Load Meter Resources
xosview*load: (True or False)
xosview*loadProcColor: color
xosview*loadIdleColor: color
xosview*loadWarnColor: color
xosview*loadCritColor: color
xosview*loadWarnThreshold: int
xosview*loadCritThreshold: int
xosview*loadCpuSpeed: (True or False)
CPU Meter Resources
xosview*cpu: (True or False)
xosview*cpuFormat: (auto, single, all or both)
| single | one meter which combines all cores. |
| all | seperate meter for each core. No combined meter. |
| both | seperate meters for each core plus a combined meter. |
| auto | a single meter on single core systems else both. |
xosview*cpuUserColor: color
xosview*cpuNiceColor: color
xosview*cpuSystemColor: color
xosview*cpuWaitColor: color
xosview*cpuInterruptColor: color
xosview*cpuSoftIntColor: color
xosview*cpuStolenColor: color
xosview*cpuGuestColor: color
xosview*cpuNiceGuestColor: color
xosview*cpuFreeColor: color
Memory Meter Resources
xosview*mem: (True or False)
xosview*memUsedColor: color
xosview*memBufferColor: color
xosview*memCacheColor: color
xosview*memSwapCacheColor: color
xosview*memFreeColor: color
xosview*memTextColor: color
xosview*memOtherColor: color
xosview*memActiveColor: color
xosview*memInactiveColor: color
Swap Meter Resources
xosview*swap: (True or False)
xosview*swapUsedColor: color
xosview*swapFreeColor: color
IRQ rate Meter Resources
xosview*irqrate: (True or False)
xosview*irqrateUsedColor: color
xosview*irqrateFreeColor: color
xosview*irqratePeak: peakIRQRate
This number is the peak value for the field meter in irq/sec. The used label will still report values over this peak.
Page Meter Resources
xosview*page: (True or False)
xosview*pageBandWidth: peakVal
xosview*pageInColor: color
xosview*pageOutColor: color
xosview*pageIdleColor: color
Wireless Link Meter Resouces
xosview*wlink: (True or False)
xosview*wlinkBackground: color
The color to use to display the background area of the meter.
xosview*wlinkGoodColor: color
xosview*wlinkPoorColor: color
xosview*wlinkPoorValue: value
Network Meter Resources
xosview*net: (True or False)
xosview*netBandwidth: maxBytes
xosview*netIface: interface
xosview*netInColor: color
xosview*netOutColor: color
xosview*netBackground: color
NFSStats (Client) Resources
xosview*NFSStats: (True or False)
xosview*NFSStatReTransColor: color
xosview*NFSStatAuthRefrshColor: color
xosview*NFSStatCallsColor: color
xosview*NFSStatIdleColor: color
NFSDStats (Server) Resources
xosview*NFSDStats: (True or False)
xosview*NFSDStatCallsColor: color
xosview*NFSDStatBadCallsColor: color
xosview*NFSDStatUDPColor: color
xosview*NFSDStatTCPColor: color
xosview*NFSDStatIdleColor: color
Serial Meter Resources
xosview*serial(0-9): (True or False)
xosview*serialOnColor: color
xosview*serialOffColor: color
Interrupt Meter Resources
xosview*interrupts: (True or False)
xosview*intOnColor: color
xosview*intOffColor: color
xosview*intFormat: (auto, single, all or both)
| single | one meter which combines all cores. |
| all | seperate meter for each core. No combined meter. |
| both | seperate meters for each core plus a combined meter. |
| auto | a single meter on single core systems else both. |
Thermal Zone Resources
xosview*tzone: (True or False)
xosview*tzoneForeGround: color
xosview*tzoneBackground: color
xosview*tzoneHotColor: color
xosview*tzoneCritColor: color
xosview*tzoneHotTrip: value
The temperature (in degrees C) to start displaying in the hot color.
xosview*tzoneCritTrip: value
The temperature (in degrees C) to start displaying in the crit color.
xosview*tzonePeak: value
Lm Sensors Temperature Resources
xosview*lmstemp: (True or False)
xosview*lmstempHighest: value
xosview*lmstempActColor: color
xosview*lmstempHighColor: color
xosview*lmstempIdleColor: color
xosview*lmstempN: filename
Note if more files with same name exists, only the first is found. There is currently no possiblity to configure equal named files on different busses (which would be rarely necessary, I hope).
eg.
xosview*lmstemp1: temp xosview*lmstemp2: remote_temp
xosview*lmstempLabelN: Labelstring
Coretemp Meter Resources
xosview*coretemp: (True or False)
xosview*coretempHighest: 100
xosview*coretempHigh: number
xosview*coretempActColor: color
xosview*coretempHighColor: color
xosview*coretempIdleColor: color
xosview*coretempDisplayType: (separate, average or maximum)
| separate | Display one meter for each CPU core of a multi-core CPU. This is the default. |
| average | Display the average of core temperatures of a multi-core CPU. On multi-socket machines, one meter per physical CPU is displayed. |
| maximum | Display the highest core temperature of a multi-core CPU. On multi-socket machines, one meter per physical CPU is displayed. |
BSD Sensor Resources
xosview*bsdsensor: (True or False)
xosview*bsdsensorHighest: number
xosview*bsdsensorActColor: color
xosview*bsdsensorHighColor: color
xosview*bsdsensorLowColor: color
xosview*bsdsensorIdleColor: color
xosview*bsdsensorN: name.type
xosview*bsdsensorHighN: name.type
xosview*bsdsensorLowN: name.type
You can find the correct pair for OpenBSD and DragonFly BSD with
systat command, e.g.
xosview*bsdsensor1: it0.temp1
xosview*bsdsensorHigh1: 100
On NetBSD, you can find the driver name with envstat command.
Value name for the actual reading is typically 'cur-value' and for high
alarm 'critical-max' and for low alarm 'critical-min', e.g.
xosview*bsdsensor2: coretemp0.cur-value
xosview*bsdsensorHigh2: coretemp0.critical-max
For all possible NetBSD value names, refer to envstat source code.
FreeBSD has no usable sensor drivers as of version 9.0. However,
ACPI thermal zones can be used by defining the sysctl node below
hw.acpi.thermal, e.g.
xosview*bsdsensor1: tz0.temperature
xosview*bsdsensorHigh1: tz0._CRT
ACPI thermal zones can be used like this on DragonFly BSD as well.
xosview*bsdsensorLabelN: string
xosview*bsdsensorHighestN: number
Battery Meter Resources
xosview*battery: (True or False)
xosview*batteryLeftColor: color
xosview*batteryUsedColor: color
xosview*batteryChargeColor: color
xosview*batteryFullColor: color
xosview*batteryLowColor: color
xosview*batteryCritColor: color
xosview*batteryNoneColor: color
Disk Meter Resources
xosview*disk: (True or False)
xosview*diskUsedColor: color
xosview*diskIdleColor: color
xosview*diskWriteColor: color
xosview*diskReadColor: color
xosview*diskBandwidth: bandwidth
File System Meter Resources
xosview*filesys: (True or False)
xosview*filesysMounts: list
xosview*filesysFGColor: color
xosview*filesysBGColor: color
xosview*filesysNoneColor: color
RAID Meter Resources
The RAID meter monitors software raid devices provided by the linux kernel. These devices have names such as md0, md1, md127 and so on. Xosview uses stats provided by the md driver in the sysfs (mounted as /sys). See the md.txt file that is part of the linux kernel documentation for more details.
The raid meter displays information for each raid device using a row for each
md device it is monitoring. Each row consists of two side by side meters.
The first meter displays a multi-colored bit for each device that is part of
the raid. The second meter shows the progress of any active sync action the
raid may have underway. The legend for the raid meter shows information such
as the raid level, current active device count, fully functional device
count and current sync_action.
The number of devices that are part of each md device are updated as xosview
watches the raid's status. So the number of bits will change as drives are
added and removed from the md device. The color of each bit reflects the
state of each device (found in the sysfs). Since a md device can have
multiple states (for example in_sync + write_error), xosview attempts to
show the configured color of the most relevant state.
When a sync action is active on the md device the field meter on the right
side of the bit meter shows the progres. It is a percentage of the total
operation and colors are configurable.
The raid meter is configured using the following resources:
xosview*RAID: (True or False)
xosview*RAIDdevices: auto OR list
xosview*RAIDfullColor:
xosview*RAIDdegradedColor:
The following colors are using for the various sync sync actions. They are
used by the legend and field meter when a sync action is underway.
- xosview*RAIDidleColor
- xosview*RAIDcheckColor
- xosview*RAIDresyncColor
- xosview*RAIDrecoverColor
- xosview*RAIDrepairColor
The colors below are used for the multi-color bit meter display. Each color
indicates a device state flag. If a device has more than one flag set, then
xosview chooses the most relevant color.
- xosview*RAIDin_syncColor
- xosview*RAIDwritemostlyColor
- xosview*RAIDreplacementColor
- xosview*RAIDspareColor
- xosview*RAIDwrite_errorColor
- xosview*RAIDwant_replaceColor
- xosview*RAIDblockedColor
- xosview*RAIDfaultyColor
OBTAINING
The most current version of xosview can be found at the following site:
The projects source tree is also available here.
BUGS
Here is a list of known bugs. Reports of unknown bugs are appreciated and should be directed to:
AUTHORS
Mike Romberg (mike-romberg@comcast.net)
Brian Grayson (bgrayson@netbsd.org)
Scott McNab (jedi@tartarus.uwa.edu.au)
Tom Pavel (pavel@slac.stanford.edu)
Greg Onufer (exodus@cheers.bungi.com)
Stefan Eilemann (eilemann@gmail.com)
Sheldon Hearn (axl@iafrica.com)
David W. Talmage (talmage@jefferson.cmf.nrl.navy.mil)
Oleg Safiullin (form@openbsd.org)
Werner Fink (werner@suse.de)
Massimiliano Ghilardi ( ghilardi@cibs.sns.it )
Carsten Schabacker (cschaba@spock.central.de)
Paal Beyer <pbeyer@online.no>
Jerome Forissier <forissier@isia.cma.fr>
Tomer Klainer <mandor@cs.huji.ac.il>
Arno Augustin (Arno.Augustin@3SOFT.de)
Alberto BARSELLA <ishark@lsh01.univ-lille1.fr>
Thomas Waldmann (ThomasWaldmann@gmx.de)
Leopold Toetsch <lt@toetsch.at>
David O'Brien (obrien@nuxi.com)
Christos Zoulas (christos@netbsd.org)
And many others who have sent in small fixes and improvements.
| 3rd Berkeley Distribution |
