xstatbar(1)                OpenBSD Reference Manual                xstatbar(1)

NAME
     xstatbar - A system information display bar for X11

SYNOPSIS
     xstatbar [-x offset] [-y offset] [-w width] [-h height] [-f font]
              [-t time-format] [-T] [-s seconds]

DESCRIPTION
     xstatbar displays an overview of basic system information (CPU usage,
     etc.), and additional information that is usefull on many laptops such as
     volume, battery life, and more.  The display tries to be as minimal as
     possible, while still providing a good overview of things.

     The window that xstatbar uses is not part of any tab-order by most window
     managers, has no decorations, and will persist across multiple
     workspaces.

     The information displayed by xstatbar is:

        For each CPU, a graph of the last 60 seconds of usage followed by the
         current breakdown, similar to what you find in top(1).
        A graph of memory usage for the last 60 seconds, followed by the cur-
         rent breakdown, again, similar to what is found in top(1).
        Swap usage (no graph).  This is shown only if any swapping is cur-
         rently taking place.
        Number of active and total processes.
        Power information, including if AC is the current source, or the BAT-
         tery, followed by a graph of the estimated remaining power, and an
         estimate of the amount of time (in minutes) remaining before the bat-
         tery is drained.
        Left and right volume levels, including graphs.
        Current date and time.

     Note that the above stats are displayed in the order listed, from left to
     right, with the exception of the date and time.  That is displayed right-
     justified in the display.

OPTIONS
     Please note that xstatbar is not highly configurable.  Only basics about
     the display (window position, size, and font used) are configurable.  For
     anything more complicated, simply edit the source.

     The following options are supported:

     -x offset   The x coordinate, in pixels, of the upper-left corner of the
                 window.

                 The default is 0.

     -y offset   The y coordinate, in pixels, of the upper-left corner of the
                 window.

                 The default is 0.

     -w width    The width of the window to use, specified in pixels.  Only
                 use this if you want to limit 's display even further.

                 The default is 1280.

     -h height   The width of the window to use, specified in pixels.

                 The default is 13.

     -f font     Specify the font to use when displaying any text.  The de-
                 fault is whatever "fixed" defaults to through
                 XLoadQueryFont(3).

     -s seconds  The number of seconds to sleep between updating the stats
                 displayed.

                 The default is 1.

     -t time-format
                 Specify the format for the time to be displayed in.  Any
                 string acceptable by strftime(3) is acceptable.

                 The default format is ``%a %d %b %Y %I:%M:%S %p''

     -T          Use the default format for displaying the time but with a
                 24-hour format.

EXAMPLES
     To display xstatbar at the bottom of your display, assuming a 1280x800
     display, use something like the following:

           $ xstatbar -y 785

     If you are using a window manager such as scrotwm(1), you can then setup
     that region of your screen as "off-limits" for windows to be placed, by
     adding the following to your scrotwm(1) configuration:

           region = screen[1]:1280x785+0+0

     This instructs scrotwm(1) to use only the region specified (for the de-
     fault screen in multi-head setups) for all other windows.  Note that 15
     pixels are "removed" from the bottom of the display, and this is where
     xstatbar would be displayed.

SEE ALSO
     scrotwm(1), strftime(3), XLoadQueryFont(3).

AUTHORS
     xstatbar was written by Ryan Flannery <ryan.flannery@gmail.com>.

CAVEATS
     As stated above, none of the actual stats, or their formatting, is con-
     figurable via command line options.  Please stop asking me this.

BUGS
     None known.  If you find any, please send a detailed description to me at
     <ryan.flannery@gmail.com>.

OpenBSD 4.8                     March 16, 2009                               2