root/foundation-apps/grosview-maxx/xosview.1

Revision 2, 26.2 KB (checked in by emasson, 3 years ago)

initial import for the community edition

Line 
1'\" t
2.\" @(#)xosview.1       1.8.3 1/99 "
3.TH XOSVIEW 1.8.3 "$Date: 2008/05/04 15:53:48 $"
4.UC
5.SH NAME
6xosview \- X based system monitor
7.SH SYNOPSIS
8xosview [options]
9.\"  ================  Macros  =============================
10.\"  First, let's define some handy roff macros.
11.\"  A macro begins with .de <xx> where one will invoke this macro with .xx
12.\"  The macro definition ends with the .. line.
13.\"  I don't know what macro abbreviations are free, so I just chose a few,
14.\"  and haven't noticed a problem so far!  bgrayson
15
16.\"  There are several paragraphs that are repeated in the resource section.
17.\"  Rather than typing the whole stuff out each time, we define a few macros.
18
19.\"  The .pp macro takes a single argument (net, disk, etc), and
20.\" prints a paragraph description of a Priority resource.  Only the
21.\" header (xosview*diskPriority: \fIpriority\fP) needs to be specified in
22.\" addition to the .pp macro.
23.\"  Usage:   .pp load
24.de pp
25xosview*\\$1Priority: \fIpriority\fP
26.RS
27This number (which must be an integer >= 1) sets the number of tenths of
28a second that the \\$1 meter waits between updates.  A value of 1 has xosview
29update the meter 10 times per second (the fastest).  A value of 600 would
30cause xosview to update the meter once a minute.
31.RE
32..
33.\"  The .dc macro is similar to the .pp macro, except that it is for
34.\" the decay resource paragraphs.
35.\"  Usage:  .dc net
36.de dc
37xosview*\\$1Decay: (True or False)
38.RS
39If True then the \\$1 meter will be split vertically in two.  The top
40half will show the instantaneous state, while the bottom half will
41display a decaying average of the state.
42.RE
43..
44.\" The .dg macro is similar to the .dc macro, except that it is for
45.\" the scrolling graph resource paragraphs.
46.\" Usage:  .dg net
47.de dg
48xosview*\\$1Graph: (True or False)
49.RS
50If this is set to True then the \\$1 meter will be drawn as a horizontally
51scrolling bargraph showing the state value verses time.
52.RE
53..
54.\"  The .pm macro is for ``plus/minus'' -- for the
55.\"  enable/disable command-line options.
56.de pm
57-\\$1
58.RS
59This option overrides the xosview*\\$1 resource.  It is
60equivalent to setting xosview*\\$1 to "False".
61.RE
62+\\$1
63.RS
64This option overrides the xosview*\\$1 resource.  It is
65equivalent to setting xosview*\\$1 to "True".
66.RE
67..
68.\"  The .xt macro is for ``Xresource true'' -- for enabling a
69.\"  meter, like the .pm macro/-+foo.
70.de xt
71xosview*\\$1: (True or False)
72.RS
73If True then xosview will display a \\$1 meter.
74.RE
75..
76.\"  The .uf macro is for the ``used format'' stuff.
77.de uf
78xosview*\\$1UsedFormat:   (float, percent or autoscale)
79.RS
80This resource tells xosview how to display "used" labels.  The formats work
81as follows:
82
83\fBfloat\fP:
84.RS
85Display the value as a floating point number.
86.RE
87\fBpercent\fP:
88.RS
89Display the value as a percentage of the total.
90.RE
91\fBautoscale\fP:
92.RS
93Display the absolute value and automatically print the units (K, M, or G) as
94appropriate.
95.RE
96.RE
97..
98.\"  Define a color macro for the various xosview*fooXXXColor: resources.
99.\"  Usage:  .cc swap Used used "swap space"  <--  keep 'swap
100\"                                                       space' as one arg.
101.de cc
102xosview*\\$1\\$2Color: \fIcolor\fP
103.RS
104The \\$1 meter will use this color to display the \\$3 field.
105.RE
106..
107.\"  ================  End of Macros  =============================
108.SH DESCRIPTION
109\fIxosview\fP is a monitor which displays the status of several system based
110parameters.  These include CPU usage, load average, memory usage, swap
111space usage, network usage, interrupts, and serial port status.  Each of
112these is displayed as a horizontal bar which is separated into color coded
113regions.  Each region represents a percentage of the resource which is being
114put to a particular use.  Typing a 'q' in the window will terminate xosview.
115
116At the moment \fIxosview\fP runs on seven platforms (Linux,
117NetBSD, FreeBSD, OpenBSD, some Solaris systems, IRIX 6.5 and HPUX).
118Not all of the meters described below are supported on all
119platforms.  Some of the meters may appear different depending upon the
120platform \fIxosview\fP is running on.  Note that *BSD is used as
121an abbreviation for all three of the free BSD operating systems
122(NetBSD, FreeBSD, OpenBSD).
123
124\fBLoad\fP
125   all platforms  :  load
126
127\fBCPU Usage\fP
128   Linux  : user | nice | system | idle
129   *BSD   : user | nice | system | interrupt | idle
130   IRIX   : user | system | interrupt | wait | idle
131   HPUX   : user | nice | system | interrupt | idle
132
133\fBMemory Usage\fP
134   Linux  : used | shared | buffers | free
135   NetBSD : active | inactive | wired | free
136   FreeBSD: active | inactive | wired | buffer | free
137   OpenBSD: active | inactive | wired | free
138   IRIX   : kernel | fs   | user    | free
139   HPUX   : text | used   | other   | free
140
141\fBSwap Usage\fP
142   all platforms except IRIX: used | free
143
144\fBDisk Usage (bytes/sec)\fP
145   Linux  : in  |  out  | idle
146   *BSD   : transferred | idle
147   HPUX   : < Not Supported >
148
149\fBPage Swapping from/to disk\fP
150   all platforms except IRIX  : in | out | idle
151
152\fBNET Usage\fP
153    bytes/sec
154    Linux  : in | out | idle
155    *BSD   : in | out | idle
156    HPUX   : < Not Supported >
157
158\fBGFX Usage\fP
159    swapbuffers/sec
160    IRIX   : number of swapbuffers
161
162\fBInterrupts\fP
163    "leds" which blink when an interrupt occurs.
164    Linux  : IRQs 0 - 15
165    *BSD   : IRQs 0 - 15 (or fewer, depending on architecture)
166    HPUX   : < Not Supported >
167
168\fBInterrupt rate\fP
169    interrupts per second
170    Linux  : < Not Supported >
171    *BSD   : interrupts | free
172    HPUX   : < Not Supported >
173
174\fBSerial Port Status\fP
175    "leds" which show the serial port parameters.
176    Linux  : Both the Line Status Register
177             (LSR) and Modem Status Register
178             (MSR) are displayed.
179    *BSD   : < Not Supported >
180    HPUX   : < Not Supported >
181
182\fBBattery Level\fP
183    Shows the current condition of the
184    battery (for laptops).
185    Linux  : %left | %used
186    NetBSD : %left | %used
187    FreeBSD: < Not Supported >
188    OpenBSD: %left | %used
189    HPUX   : < Not Supported >
190
191\fBRAID status\fP
192    Shows the state of disks contained in your (software)
193    RAID1/4/5 array(s) and the rebuild state of the
194    array(s).
195    Linux  : Disk0 Disk1 Disk2 .. DiskN | Rebuild Progress
196
197.SH OPTIONS
198
199Most of these command line options are just a convenient way to set one or
200more of xosview's resources.  Please see the \fBRESOURCES\fP section for
201more details on what the resource is for.
202
203-v
204.RS
205Displays the version number.
206.RE
207
208-name \fIname\fP
209.RS
210Sets the Resource name xosview will use (same as the -name option
211for typical X applications like xterm).  When performing resource
212lookups, xosview will look under \fIname\fP, and then under
213``xosview''.  For an example, perform the following (as
214documented in README.netbsd):
215.RS
216  xrdb -merge Xdefaults.stipple
217  xosview -name xosvstipple &
218  xosview -name xosvstipplebw &
219.RE
220
221.RE
222
223-display \fIdisplay\fP
224.RS
225Sets the X display to \fIdisplay\fP.  This option overrides the
226xosview*display resource.
227.RE
228
229-font \fIfont\fP
230.RS
231Specifies the font xosview will use for labels.  This option overrides the
232xosview*font resource.
233.RE
234
235-title \fItitle\fP
236.RS
237This option sets the name xosview will tell the window manager to use for
238the X window and icon.  This option overrides the xosview*title resource.
239.RE
240
241-geometry \fIgeometry_string\fP
242.RS
243Sets the X geometry to \fIgeometry_string\fP.  This option overrides the
244xosview*geometry resource.
245.RE
246
247.\"  Handle -/+captions
248.pm captions
249
250.\"  Handle -/+labels
251.pm labels
252
253-usedlabels
254.RS
255This option overrides the xosview*usedlabels resource.  It is equivalent to
256setting xosview*usedlabels to "False".
257.RE
258
259+usedlabels
260.RS
261This option overrides the xosview*usedlabels resource.  It is equivalent to
262setting xosview*usedlabels to "True".
263.RE
264
265.\"  Handle -/+cpu
266.pm cpu
267
268.\"  Handle -/+load
269.pm load
270
271.\"  Handle -/+mem
272.pm mem
273
274.\"  Handle -/+swap
275.pm swap
276
277.\"  Handle -/+battery
278.pm battery
279
280.\"  Handle -/+gfx
281.pm gfx
282
283.\"  Handle -/+net
284.pm net
285
286-network \fImaxbandwidth\fP
287.RE
288-networkBW \fImaxbandwidth\fP
289.RE
290-networkBandwidth \fImaxbandwidth\fP
291.RS
292These options override the xosview*netBandwidth resource.  They cause
293xosview to display a meter that will shows network usage, with a maximum
294bandwidth of \fBmaxbandwidth\fP.  Notice that setting the bandwidth to
2950 no longer disables the meter -- use the ``-net'' option instead.
296.RE
297
298.\"  Handle -/+page
299.pm page
300
301-pagespeed \fIval\fP
302.RS
303This option overrides the xosview*pageBandWidth resource.  The resource
304xosview*pageBandWidth will be set to \fIval\fP.
305.RE
306
307.\"  Handle -/+disk
308.pm disk
309
310.\"  Handle -/+ int
311.pm int
312
313-ints +ints
314.RE
315-interrupts +interrupts
316.RS
317Equivalent to -int and +int.
318.RE
319
320.pm irqrate
321
322-intrate +intrate
323.RS
324Equivalent to -irqrate and +irqrate.
325.RE
326
327.\"  Handle -/+lmstemp
328.pm lmstemp
329.RE
330
331-xrm \fIresource_string\fP
332.RS
333This switch allows any of xosview's resources to be set on the command line.
334An example of how the xosview*memFreeColor could be set using this option is
335shown below (Note the use of " to prevent the shell from expanding
336\'*\' or from creating two separate arguments, \'xosview*memfreeColor:\'
337and \'purple\'):
338.RS
339-xrm "xosview*memFreeColor: purple"
340.RE
341.RE
342
343.SH X RESOURCES
344
345The following is a list of X resources supported by \fIxosview\fP.  Each has
346a default value assigned to it.  These values can be found in the file
347Xdefaults which can be obtained in the source distribution of xosview.
348They can be overridden in the usual places (/usr/lib/X11/app-defaults/XOsview,
349$HOME/.Xdefaults, etc.).
350
351It should be noted that it is OK to have a resource defined for a port of
352xosview that does not support the feature the resource configures.  Xosview
353will simply ignore the resources that are set for it but not supported on
354a given platform.
355
356
357\fBGeneral Resources\fP
358
359
360xosview*title: \fIname\fP
361.RS
362The string that xosview will use for the X window title.  Normally xosview
363will use 'xosview@machine_name' for a title.  This resource overrides the
364default behavior.
365.RE
366
367xosview*geometry: \fIgeometry_string\fP
368.RS
369This is a standard X geometry string that defines the size and location of
370the X window used by xosview.
371.RE
372
373xosview*display: \fIname\fP
374.RS
375The name of the display where xosview will contact the X server for drawing
376its window.
377.RE
378
379xosview*pixmapName: \fIname\fP
380.RS
381The filename of an X pixmap (xpm) file for use as a background
382image.
383.RE
384
385xosview*captions: (True or False)
386.RS
387If True then xosview will display meter captions.
388.RE
389
390xosview*labels: (True or False)
391.RS
392If True then xosview will display meter labels.
393.RE
394
395xosview*meterLabelColor: \fIcolor\fP
396.RS
397The color to use for the meter labels.
398.RE
399
400xosview*usedlabels: (True or False)
401.RS
402If True then xosview will display labels that show the percentage of the
403resource (or absolute amount, depending on the meter) being used.  This
404option requires that the labels option also be set to True.
405.RE
406
407xosview*usedLabelColor: \fIcolor\fP
408.RS
409The color to use for "used" labels.
410.RE
411
412xosview*borderwidth:  \fIwidth\fP
413.RS
414The width of the border for the xosview window.
415.RE
416
417xosview*font: \fIfont\fP
418.RS
419This is the font that xosview will use.
420.RE
421
422xosview*background: \fIcolor\fP
423.RS
424This is the color that will be used for the background.
425.RE
426
427xosview*foreground: \fIcolor\fP
428.RS
429This is the color that will be used for the foreground.
430.RE
431
432xosview*enableStipple:  (True or False)
433.RS
434Change to true to try stipple support.  This is primarily for users
435stuck with 1-bit monitors/display cards.  Try setting enableStipple
436true.  Please give us feedback on this, if you use it.  It needs
437some more work, but no one has given us any feedback so far.
438.RE
439
440xosview*graphNumCols: \fInumber\fP
441.RS
442This defines the number of sample bars drawn when a meter is in scrolling
443graph mode. This also has the side-effect of defining the width of the
444graph columns. This is only used by meters which have graph mode enabled.
445.RE
446
447
448\fBLoad Meter Resources\fP
449
450
451.\"  Do the load: True resource.
452.xt load
453
454xosview*loadWarnColor: \fIcolor\fP
455.RS
456This is the color that the load meter will use once the load average is
457greater than 1.
458.RE
459
460xosview*loadProcColor: \fIcolor\fP
461.RS
462This is the color that the load meter will use to display the load average
463when it is less than or equal to 1.
464.RE
465
466.\"  loadIdleColor
467.cc load Idle idle
468
469.\"  Do the priority resource
470.pp load
471
472xosview*loadWarnThreshold: \fIint\fP
473.RS
474This number (which must be an integer >= 1) sets the value at which
475the loadmeter changes its status and color from "normal" to "alarm".
476The default value is 2.
477.RE
478
479xosview*loadDecay: (True or False)
480.RS
481You should probably leave this at the default value (False).  The load
482is already a time-averaged value!
483.RE
484
485.dg load
486
487.\"  loadUsedFormat resource
488.uf load
489
490xosview*loadCpuSpeed:   (True or False)
491.RS
492Display the current CPU speed in the load meter.
493.RE
494
495\fBCPU Meter Resources\fP
496
497
498xosview*cpu: (True or False)
499.RS
500If True then xosview will display a cpu meter.  On linux SMP machines this
501will cause a seperate meter to be displayed for each cpu if Jerome Forissier's
502kernel patch has been applied.  See the 'README.linux' file for more
503details. On IRIX 6.5, the resource cpuFormat decides which meters are
504created for multiple CPUs.
505.RE
506
507.\"  cpuUserColor, cpuNiceColor, cpuSystemColor, cpuInterruptColor, cpuFreeColor
508.cc cpu User "cpu user time"
509.cc cpu Nice "cpu nice time"
510.cc cpu System "cpu system time"
511.cc cpu Interrupt "cpu interrupt time"
512.cc cpu Free "cpu idle time"
513
514.\"  Priority, decay, usedFormat resources:
515.pp cpu
516.dc cpu
517.dg cpu
518.uf cpu
519
520xosview*cpuFormat: (single, all, both or auto)
521.RS
522IRIX only.
523.RE
524.RS
525If single, only a cumulative meter for all CPU is created. All creates a
526meter for each CPU, but no cumulative meter. Both creates one cumulative
527meter and one per cpu. auto behaves like single on uniprocessor system,
528and like both on multiprocessor systems.
529.RE
530
531
532
533\fBMemory Meter Resources\fP
534
535
536.\"  Do the mem: True resource.
537.xt mem
538
539.\"  mem{Used,Share,Buffer,...}Color resources
540.cc mem Used "used memory"
541.cc mem Shared "shared memory"
542.cc mem Buffer "buffer memory"
543.cc mem Cache "cache memory"
544.cc mem Free "free memory"
545.cc mem Shared "shared memory"
546.cc mem Text "HP text memory"
547.cc mem Other "HP ``other'' memory"
548.cc mem Active "NetBSD active memory"
549.cc mem Inactive "NetBSD inactive memory"
550
551.\"  Priority, decay, usedFormat resources:
552.pp mem
553.dc mem
554.dg mem
555.uf mem
556
557
558\fBSwap Meter Resources\fP
559
560.\"  Do the swap: True resource.
561.xt swap
562
563.\"  swap{Used,Free}Color resources.
564.cc swap Used "used swap"
565.cc swap Free "free swap"
566
567.\"  Priority, decay, usedFormat resources:
568.pp swap
569.dc swap
570.dg swap
571.uf swap
572
573
574\fBPage Swapping Meter Resources\fP
575
576.\"  Do the page: True resource.
577.xt page
578
579xosview*pageBandWidth: \fImaxEvents\fP
580.RS
581This number is used to specify the expected maximum bandwidth (in events /
582sec) for the page meter.  When the expected maximum bandwidth
583(\fImaxEvents\fP) is exceeded then the page meter will display the relative
584percentage of page swapping (25% in, 75% out).
585.RE
586
587.\"  page{In,Out,Idle}Color:
588.cc page In page-in
589.cc page Out page-out
590.cc page Idle idle
591
592.\"  Priority, decay, usedFormat resources:
593.pp page
594.dc page
595.dg page
596.uf page
597
598
599\fBGfx Meter Resources\fP
600
601
602xosview*gfx:    (True or False)
603.RS
604If True xosview will display the GfxMeter. The value is sampled once per
605second, due to the usage of sadc to sample data.
606.RE
607
608xosview*gfxWarnColor: \fIcolor\fP
609.RS
610This is the color that the gfx meter will use once the warn state is
611reached.
612.RE
613
614xosview*gfxAlarmColor: \fIcolor\fP
615.RS
616This is the color that the gfx meter will use once the alarm state is
617reached.
618.RE
619
620xosview*gfxSwapColor: \fIcolor\fP
621.RS
622This is the color that the gfx meter will use in normal state
623.RE
624
625.\"  gfxIdleColor
626.cc gfx Idle idle
627
628.\"  Do the priority resource
629.pp gfx
630
631xosview*gfxWarnThreshold: \fIint\fP
632.RS
633This number (which must be an integer >= 1) of swapbuffers per second
634and pipe at which the gfxmeter changes its status and color from
635"normal" to "warn". The default value is 60.
636.RE
637
638xosview*gfxAlarmThreshold: \fIint\fP
639.RS
640This number (which must be an integer >= gfxWarnThreshold) of
641swapbuffers per second and pipe at which the gfxmeter changes its status
642and color from "warn" to "alarm". The default value is 120.
643.RE
644
645xosview*gfxDecay: (True or False)
646.RS
647You should probably leave this at the default value (False).  The gfx
648does not work in decay mode.
649.RE
650
651.dg gfx
652
653.\"  gfxUsedFormat resource
654.uf gfx
655
656
657\fBNetwork Meter Resources\fP
658
659
660xosview*net:    (True or False)
661.RS
662If True xosview will display the NetMeter.  Linux users will have to configure
663their kernels and setup some ip accounting rules to make this work.  See the
664file README.linux which comes with the xosview distribution for details.
665.RE
666
667xosview*netBandwidth: \fImaxBytes\fP
668.RS
669This number is used to specify the expected maximum bandwidth
670(in bytes / sec) for the meter.  When the expected maximum bandwidth
671(\fImaxBytes\fP) is exceeded then the network meter will display the
672relative percentage of network usage (25% incomming, 75% outgoing).
673.RE
674
675xosview*netIface: \fIinterface\fP
676.RS
677If False, xosview will display the data received/transmitted by any of
678the network interfaces. Otherwise, xosview will only display the data
679received/transmitted by the specified network interface.
680
681.\"  net{In,Out}Color:
682.cc net In incoming
683.cc net Out outgoing
684.\"  FIXME XXX  Change the netBackground resource to be netIdleColor.
685
686xosview*netBackground: \fIcolor\fP
687.RS
688This is the color that the network meter will use for the "idle" field.
689.RE
690
691.\"  Priority, decay, usedFormat resources:
692.pp net
693.dc net
694.dg net
695.uf net
696
697\fBNFSStats (Client) Resources\fP
698
699
700xosview*NFSStats: (True or False)
701.RS
702If True then xosview will display a meter to monitor NFS client stats.
703.RE
704
705xosview*NFSStatReTransColor: \fIcolor\fP
706.RS
707The color to be used for retransmit stats.
708.RE
709
710xosview*NFSStatAuthRefrshColor: \fIcolor\fP
711.RS
712The color to be used for auth refresh stats.
713.RE
714
715xosview*NFSStatCallsColor: \fIcolor\fP
716.RS
717The color to be used for call stats.
718.RE
719
720xosview*NFSStatIdleColor: \fIcolor\fP
721.RS
722The color to be used for idle stats.
723.RE
724
725
726\fBNFSDStats (Server) Resources\fP
727
728xosview*NFSDStats: (True or False)
729.RS
730If True xosview will display a meter for NFS server/daemon stats.
731.RE
732
733xosview*NFSDStatCallsColor: \fIcolor\fP
734.RS
735The color to be used for call stats.
736.RE
737
738xosview*NFSDStatBadCallsColor: \fIcolor\fP
739.RS
740The color to be used for bad stats.
741.RE
742
743xosview*NFSDStatUDPColor: \fIcolor\fP
744.RS
745The color to be used for UDP stats.
746.RE
747
748xosview*NFSDStatTCPColor: \fIcolor\fP
749.RS
750The color to be used for TCP stats.
751.RE
752
753xosview*NFSDStatIdleColor: \fIcolor\fP
754.RS
755The color to be used for idle stats.
756.RE
757
758
759\fBSerial Meter Resources\fP
760
761
762xosview*serial(0-9): (True, False, or portBase)
763.RS
764If True then xosview will display a serial meter for ttySx.  The
765portbase will be autodetected.  Because autodetection can fail, (if
766the port is locked by ppp/slip for example) you can specify the
767portbase instead of "True".  If a portBase is used then xosview will use
768it instead of trying to autodetect.
769
770For this to work on Linux xosview needs to be suid root in order to have
771access to the ports.  See the file README.linux which comes with the xosview
772distribution for more details.
773.RE
774
775xosview*serialOnColor: \fIcolor\fP
776.RS
777This is the color the serial meter will use for bits that are set.
778.RE
779
780xosview*serialOffColor: \fIcolor\fP
781.RS
782This is the color the serial meter will use for bits that are not set.
783.RE
784
785.\"  Do the priority resource
786.pp serial
787
788
789\fBInterrupt Meter Resources\fP
790
791
792xosview*interrupts: (True or False)
793.RS
794If True then xosview will display an interrupt meter.
795.RE
796
797xosview*intOnColor: \fIcolor\fP
798.RS
799This is the color that will be used to show "active" interrupts.
800.RE
801
802xosview*intOffColor: \fIcolor\fP
803.RS
804This is the color that will be used to show "inactive" interrupts.
805.RE
806
807.\"  Do the priority resource
808.pp int
809
810
811\fBLm Sensors Temperature Resources\fP
812
813.xt lmstemp
814
815xosview*lmstempHighest: 100
816.RS
817Highest temp value displayed, default 100.
818.RE
819
820xosview*lmstempActColor:  \fIcolor\fP
821.RS
822Color of actual temperature.
823.RE
824
825xosview*lmstempHighColor:  \fIcolor\fP
826.RS
827Color above alarm temperature, also used to indicate alarm.
828.RE
829
830xosview*lmstempIdleColor:   \fIcolor\fP
831.RS
832Color between actual and alarm temperatures.
833.RE
834
835xosview*lmstemp\fIN\fP: \fIfilename\fP
836.RS
837Name of temperature file from /proc/sys/dev/sensors/*/*, N=1..
838.br
839Note if more files with same name exists, only the first is found. There is
840currently no possiblity to configure equal named files on different busses
841(which would be rarely necessary, I hope).
842.br
843eg.
844.br
845xosview*lmstemp1:       temp
846xosview*lmstemp2:       remote_temp
847.RE
848
849xosview*lmstempLabel\fIN\fP:    \fILabelstring\fP
850.RS
851N-th label for above temperatures, default is TMP.
852.RE
853
854.pp lmstemp
855.uf lmstemp
856
857\fBBattery Meter Resources\fP
858
859xosview*battery: (True or False)
860.RS
861If True then xosview will display a battery meter.  Linux users will need
862to have APM or ACPI support in their kernels for this to work.
863For both, APM and ACPI xosview shows the status/sum of all batteries.
864Additionally - the legend text gets changed/adjusted to reflect the
865current state (charging/low/critical/etc.) of the battery/batteries.
866.RE
867
868xosview*batteryLeftColor: \fIcolor\fP
869.RS
870This is the color that will be used to show the amount of battery power left.
871.RE
872
873xosview*batteryUsedColor: \fIcolor\fP
874.RS
875This is the color that will be used to show the amount of battery power used.
876.RE
877
878xosview*batteryChargeColor: \fIcolor\fP
879.RS
880This is the color that will be used as 'left' - if the batteries get charged.
881.RE
882
883xosview*batteryFullColor: \fIcolor\fP
884.RS
885This is the color that will be used as 'left' - if the batteries are fully charged.
886APM and ACPI does provide this info, but not all machines actually do so.
887.RE
888
889xosview*batteryLowColor: \fIcolor\fP
890.RS
891APM only - the 'left' color that will indicate a low battery.
892Depends on the machine - e.g. below 25% remaining capacity.
893.RE
894
895xosview*batteryCritColor: \fIcolor\fP
896.RS
897APM case: the 'left' color if APM indicates 'critical' state. (less than 5%)
898
899ACPI case: the 'left' color if the remaining capacity is below the alarm value.
900(which can be set by the user in /proc/acpi/battery/BAT[01]/alarm )
901.RE
902
903xosview*batteryNoneColor: \fIcolor\fP
904.RS
905If no battery is present - or all batteries get removed (while on AC).
906.RE
907
908
909.\"  Do the priority resource
910.pp battery
911.uf battery
912
913\fBDisk Meter Resources\fP
914
915.\"  Do the disk: True resource.
916.xt disk
917
918.\"  disk colors
919.cc disk Used "bytes transferred (in or out)"
920.cc disk Idle idle
921
922xosview*diskBandwidth: \fIbandwidth\fP
923.RS
924This number is used to specify the expected maximum bandwidth in bytes
925per second for the disk meter.
926.RE
927
928xosview*diskWriteColor: \fIcolor\fP
929.RS
930This color will be used for the linux meter to show writes.
931.RE
932
933xosview*diskReadColor: \fIcolor\fP
934.RS
935This color will be used for the linux meter to show reads.
936.RE
937
938.\"  Priority, decay, usedFormat resources:
939.pp disk
940.dc disk
941.dg disk
942.uf disk
943
944\fBRAID Meter Resources\fP
945
946.\"  Do the RAID: True resource.
947.xt RAID
948
949xosview*RAIDdevicecount: \fIint\fP
950.RS
951Please enter your RAID device count (n) here or 0 if you don't have any
952supported RAID devices. xosview then will display n RAID state displays.
953.RE
954
955xosview*RAIDdiskOnlineColor: \fIcolor\fP
956
957xosview*RAIDdiskFailureColor: \fIcolor\fP
958.RS
959These colors will be used for indicating working/online or failed/offline
960disks. The order (from left to right) is the same as in /proc/mdstat.
961.RE
962
963xosview*RAIDresyncdoneColor: \fIcolor\fP
964
965xosview*RAIDresynctodoColor: \fIcolor\fP
966
967xosview*RAIDresynccompleteColor: \fIcolor\fP
968.RS
969If a resync/rebuild of the RAID array is in progress, the "done" and "todo"
970colors will be used. If no rebuild/resync is running, then the "complete"
971color will be shown.
972.RE
973
974.\"  RAIDpriority resource
975.pp RAID
976
977.\"  RAIDUsedFormat resource
978.uf RAID
979
980.SH BUGS
981
982
983Here is a list of known bugs.  Reports of unknown bugs are
984appreciated and should be directed to:
985
986.RS
987Mike Romberg (mike.romberg@noaa.gov)
988.RS
989General xosview bugs and bugs related to the Linux and HPUX ports.
990.RE
991.RE
992
993.RS
994Brian Grayson (bgrayson@netbsd.org)
995.RS
996Bugs related to the NetBSD port.  I am also a catch-all for bug
997reports for the other *BSDs and SunOS.
998.RE
999.RE
1000
1001.RS
1002Stefan Eilemann (eile@sgi.com)
1003.RS
1004Bugs related to the IRIX port.
1005.RE
1006.RE
1007
1008.SH OBTAINING
1009
1010The most current version of xosview can be found at the following sites:
1011
1012.RS
1013http://xosview.sourceforge.net
1014.RE
1015.RS
1016ftp://sunsite.unc.edu/pub/Linux/system/status/xstatus
1017.RE
1018
1019For *BSD users with the ports/package system, the
1020sysutils/xosview tree ought to also have a version that is just
1021as up-to-date.
1022
1023.SH AUTHORS
1024
1025Mike Romberg  (mike.romberg@noaa.gov)
1026.RS
1027Original author, Linux and HPUX ports.
1028.RE
1029
1030Brian Grayson (bgrayson@netbsd.org)
1031.RS
1032NetBSD port and most of the nice enhancements for version 1.4,
1033initial work on FreeBSD port.
1034.RE
1035
1036Scott McNab (jedi@tartarus.uwa.edu.au)
1037.RS
1038Added the scrolling graph mode.
1039.RE
1040
1041Tom Pavel (pavel@slac.stanford.edu)
1042.RS
1043Most of the FreeBSD support, more resource-handling improvements.
1044.RE
1045
1046Greg Onufer (exodus@cheers.bungi.com)
1047.RS
1048SunOS port.
1049.RE
1050
1051Stefan Eilemann (eile@sgi.com)
1052.RS
1053IRIX 6.5 port.
1054.RE
1055
1056Sheldon Hearn (axl@iafrica.com)
1057.RS
1058FreeBSD libdevstat-based diskmeter support.
1059.RE
1060
1061David W. Talmage (talmage@jefferson.cmf.nrl.navy.mil)
1062.RS
1063Added battery-meter support to NetBSD.
1064.RE
1065
1066Oleg Safiullin (form@openbsd.org)
1067.RS
1068OpenBSD interrupt-meter support.
1069.RE
1070
1071Werner Fink (werner@suse.de)
1072.RS
1073Originator of the loadmeter.
1074.RE
1075
1076Massimiliano Ghilardi ( ghilardi@cibs.sns.it )
1077.RS
1078Linux pagemeter.
1079.RE
1080
1081Carsten Schabacker (cschaba@spock.central.de)
1082.RS
1083Made extensions to the serial-meter.
1084.RE
1085
1086Paal Beyer <pbeyer@online.no>
1087.RS
1088Ported the linux memstat kernel module to linux-2.1
1089.RE
1090
1091Jerome Forissier <forissier@isia.cma.fr>
1092.RS
1093Maintains the linux SMP kernel patch which xosview uses to display meters
1094for each cpu.  This patch can be found at the following URL:
1095.RS
1096http://www-isia.cma.fr/~forissie/smp_kernel_patch/
1097.RE
1098.RE
1099
1100Tomer Klainer <mandor@cs.huji.ac.il>
1101.RS
1102Initial port to BSDI.
1103.RE
1104
1105Arno Augustin (Arno.Augustin@3SOFT.de)
1106.RS
1107Solaris disk and network meters.
1108.RE
1109
1110Alberto BARSELLA <ishark@lsh01.univ-lille1.fr>
1111.RS
1112Fixes for linux diskmeter + ip_chains support
1113.RE
1114
1115Thomas Waldmann (ThomasWaldmann@gmx.de)
1116.RS
1117Linux raid meter, bitfieldmeter.
1118Many cosmetic fixes.
1119.RE
1120
1121Leopold Toetsch <lt@toetsch.at>
1122.RS
1123Linux lms temp meter.
1124.RE
1125
1126David O'Brien (obrien@nuxi.com)
1127.RS
1128FreeBSD 4.* updates, and a few other suggestions.
1129.RE
1130
1131Christos Zoulas (christos@netbsd.org)
1132.RS
1133C++ standard compliance and other NetBSD fixes.
1134.RE
1135
1136And many others who have sent in small fixes and improvements.
Note: See TracBrowser for help on using the browser.