XCPUSTATE(1) User Commands XCPUSTATE(1)

NAME

xcpustate - display CPU states (idle, nice, system, kernel)
statistics

SYNTAX

xcpustate [ -toolkitoption ...] [ -count iterations] [ -interval
seconds] [ -shorten components] [ -cpu] [ -nocpu] [ -disk] [ -nodisk]
[ -wait] [ -nowait] [ -filltype auto|grayscale|color|tile|stipple] [
-version] [ -colors colorname[,colorname[,...]]] [ -avg iterations]

DESCRIPTION

Xcpustate displays bars showing the percentage of time the CPU spends
in different states. It optionally indicates disk states in the same
manner.

Bars indicate the proportions of idle + wait, user, and kernel time
for each CPU. If the ``wait'' option is set, the bars indicate idle,
wait, user, and system/kernel time, from left to right.

OPTIONS

Xcpustate accepts all of the standard X Toolkit command line options,
plus:

-count iterations
The number of times it should update the display. Default is
forever.

-avg iterations
The number of iterations the bar values should be averaged
over. Default is one.

-interval seconds
the interval in seconds (fractions permitted) between
updates. Default is 1 second.

-shorten components
On some systems, xcpustate will display the hostname in the
bar labels. Since some fully qualified domain names can be
very long, this option allows them to be shortened to a
specific number of components. eg. if your hostname is
foo.wherever.edu, you can shorten it to foo by specifying
-shorten 1 or to foo.wherever by specifying -shorten 2 .
Specifying -shorten 0 will omit the hostname completely; a
negative number will cause xcpustate to draw unlabeled bars.
Some systems may not support this option.

-cpu Display CPU statistics (default).

-nocpu Do not display CPU statistics.

-disk Display Disk statistics. The bars report idle, wait, and run
time.

-nodisk Do not display disk statistics (default).

-wait Display CPU disk/system wait time as a separate statistic, if
appropriate.

-nowait Include CPU disk/system wait time as part of idle (default).

-version
Print out version information and exit.

-filltype
Specify the method xcpustate should use to fill the bars.
Available options include grayscale, color, tile, stipple, or
auto. Auto automatically chooses between tiling, grayscale,
and colour, depending on your display type. Auto is the
default.

-colors Specify the colors used to draw the bars. Colors are
specified in left-to-right order, separated by commas. A
single dot can be used to specify the default color at that
position. Up to ten colors may be specified. Defaults are
used for the leftmost colors if less than ten are specified.

X DEFAULTS

For xcpustate the available class identifiers are:

CPUStateMonitor - the application
Form - enclosing the entire application, and sub-Forms enclosing
Label/Bar pairs.

For xcpustate, the available name identifiers are:

xcpustate - application name
The outer Form is "form".
The Forms enclosing the Label/Bar pairs are "formN", where N is the
index number, starting with the top pair as zero.
Each Label name is the same as the label string.
Each Bar name is "barN".


For xcpustate, the available resources are:

name interval, class Interval
corresponds to the -interval option. Takes a float value.

name count, class Count
corresponds to the -count argument. Takes an integer value.

name avg, class Avg
corresponds to the -avg argument. Takes an integer value.

name shorten, class Shorten
corresponds to the -shorten argument. Takes an integer value.

name cpu, class Cpu
corresponds to the -cpu and -nocpu arguments. Takes a boolean
value.

name disk, class Disk
corresponds to the -disk and -nodisk arguments. Takes a
boolean value.

name wait, class Wait
corresponds to the -wait and -nowait arguments. Takes a
boolean value.

name filltype, class Filltype
corresponds to the -filltype argument. Takes a string.

name host, class Host
corresponds to the -host argument. Takes a hostname.

name colors, class Colors
corresponds to the -colors argument. Takes a comma-separated
list of color names.

NOTES

Xcpustate is meant to be easy to port, and extend to monitor a wide
variety of statistics.

SEE ALSO

xperfmon, xload, xosview

AUTHORS

Mark Moraes at D. E. Shaw wrote the original X code and the SGI IRIX
code. He also enhanced the code for the Bar widget to support color.
John DiMarco at the University of Toronto is the current maintainer.
He contributed to the color support, fixed some minor problems, added
support for SunOS 4.x multiprocessors, SunOS 5.x, disks, Omni network
coprocessors, AIX (SMP on AIX 4.x) and RSTAT. Thanks to David O'Brien
of the University of California, Davis for the 4.4BSD code, Chris
Siebenmann of the University of Toronto for the code for 4.3BSD
systems; Walter D. Poxon from Cray Research for the code for Cray
machines running Unicos; Melinda Shore at mt Xinu for the code for
Mach systems; Bill Kucharski at Solbourne for the code for Solbourne
systems; Salvador Pinto Abreu at Universidade Nova de Lisboa,
Portugal, for the code for Ultrix multiprocessors; Hugues Leroy at
Irisa, Rennes, France for the code for Gould NP1 bi-processors, Bruce
Frost at NCR for the code for (Dell) SVR4 and NCR systems, and Kumsup
Lee at the University of Minnesota and Greg Nakhimovsky at Sun
Microsystems for the Linux code. Thanks also to Robert Montjoy from
the University of Cincinatti for contributing and testing some of the
SunOS 5.x code, to Dave Cahlander from Cray for cleaning up the X
resource code, and to Ron Wigmore from Ryerson Polytechnic University
for his assistance with the AIX port.

BUGS

Xcpustate may initially display nonsensical data, before being
updated the first time.

The use of very small (significantly less than one second) intervals
may result in xcpustate using significant resources, particularly
when running over the network. A minimum interval may be specified
as a compile-time option, and intervals less than this will not be
permitted.

February 18, 2024 XCPUSTATE(1)