readme

系统任务管理器

GKrellM - GNU (or Gtk) Krell Monitors (or Meters)
=======================================================================

Author:	Bill Wilson
Email:  billw--at--gkrellm.net
Homepage: http://gkrellm.net

Copyright (c) 1999-2006 by Bill Wilson.  This program is free software
which I release under the GNU General Public License.
Read the COPYRIGHT file for more info.


Description
===========
With a single process, GKrellM manages multiple stacked monitors and supports
applying themes to match the monitors appearance to your window manager,
Gtk, or any other theme.


GKrellM Features
================
	* SMP CPU, Disk, Proc, and active net interface monitors with LEDs.
	* Internet monitor that displays current and charts historical port hits.
	* Memory and swap space usage meters and a system uptime monitor.
	* File system meters show capacity/free space and can mount/umount.
	* A mbox/maildir/MH/POP3/IMAP mail monitor which can launch a mail reader
	  or remote mail fetch program.
	* Clock/calendar and hostname display.
	* Battery laptop battery monitor.
	* CPU/motherboard temperature/fan/voltages display with warnings and
	  alarms.  Linux requires a sensor configured sysfs, lm_sensors modules or
	  a running mbmon daemon.  FreeBSD can also read the mbmon daemon.
	  Windows requires MBM.
	* Disk temperatures if there's a running hddtemp daemon.
	* Multiple monitors managed by a single process to reduce system load.
	* A timer button that can execute PPP or ISDN logon/logoff scripts.
	* Charts are autoscaling with configurable grid line resolution, or
	  can be set to a fixed scale mode.
	* Separate colors for "in" and "out" data.  The in color is used for
	  CPU user time, disk read, forks, and net receive data.  The out color
	  is used for CPU sys time, disk write, load, and net transmit data.
	* Commands can be configured to run when monitor labels are clicked.
	* GKrellM is plugin capable so special interest monitors can be created.
	* Data can be collected from a gkrellmd server running on a remote machine.
	* Many themes are available.


User Interface
==============
	* Top frame:
		Btn 1   - Press and drag to move gkrellm window.
		Btn 3   - Popup main menu.
	* Side frames:
		Btn 2   - Slide gkrellm window shut (Btn1 if -m2 option).
		Btn 3   - Popup main menu.
	* All charts
		Btn 1   - Toggle draw of extra info on the chart.
		Btn 3   - Brings up a chart configuration window.
	* Inet charts
		Btn 2	- toggle between port hits per minute and hour.
	* Most panels
		Btn 3   - Opens the configuration window directly to a monitor's
		          configuration page.
	* File System meter panels:
		Btn 1,2	- Toggle display of label and fs capacity scrolling display.
		          The mount button runs mount/umount commands.  If ejectable,
		          left click the eject button to open tray, right click closes.
	* Mem and Swap meter panels:
		Btn 1,2	- Toggle display of label and memory or swap capacity
	              scrolling display.
	* Mailbox monitor message count button:
		Btn 1	- Launch a mail reader program.  If options permit, also
	              stop animations and reset remote message counts.
		Btn 2	- Toggle mail check mute mode which inhibits the sound
	              notify progra, and optionally inhibits all mail checking.
	* Mailbox monitor envelope decal:
		Btn 1	- Force a mail check regardless of mute or timeout state.
	* Battery monitor panel:
		Btn 1	- On the charging state decal toggles battery minutes left,
	              percent level, and charge rate display.
		Btn 2	- Anywhere on the panel also toggles the display.

  Keyboard shortcuts:
	* F1  = popup the user config window.
	* F2  = popup the main menu.
	* Page_Up        - previous theme or theme alternative.
	* Page_Down      - next theme or theme alternative.
	* <Ctl>Page_Up   - previous theme, skipping any theme alternatives.
	* <Ctl>Page_Down - next theme, skipping any theme alternatives.

    If a command has been configured to be launched for a monitor, then
    a button will appear when the mouse enters the panel of that monitor.
    Clicking the button will launch the command.


Requirements
============
To use or compile GKrellM, you need:
	* Gtk+-2.0
To compile, you additionally need the development libs.


Installation
============
See the INSTALL file.  BSD systems will need to use GNU gmake.


Running GKrellM
===============
To get a list of options:

	gkrellm --help

Some of the options are:
	-t, --theme  theme_dir
	   GKrellM will load all theme image files it finds in theme_dir
	   and parse the gkrellmrc file if one exists.  This option overrides
	   the loading of the last theme you configured to be loaded in
	   the Themes configuration window.  Theme changes are not saved
	   when GKrellM is run with this option.
	-g, --geometry +x+y
	   Or -g +x+y.  Makes GKrellM move to an x y postition on the screen
	   at startup.  Standard X window geometry position (not size) formats
	   are parsed, ie +x+y -x+y +x-y -x-y.  Except, negative geometry
	   positions are not recognized (ie +-x--y )
	-wm
	   Forces GKrellM to start up with window manager decorations.  The
	   default is no decorations because there are themed borders.
	-w, --withdrawn
	   GKrellM starts up in withdrawn mode so it can go into a window
	   manager's slit.  This should work with the Blackbox, Fluxbox, Kahakai,
	   Waimea, and maybe other window managers with the slit feature.
	-c, --config  suffix
	   Use alternate config files generated by appending "suffix" to config
	   file names.  This overrides any previous host config which may have
	   been setup with the below option.
	-f, --force-host-config
	   If GKrellM is run once with this option and then the configuration
	   or theme is changed, the config files that are written will have
	   a -hostname appended to them.  Subsequent runs will detect the
	   user-config-hostname and gkrellm_theme.cfg-hostname files and use
	   them instead of the normal configuration files (unless the --config
	   option is specified).   This is a convenience for allowing
	   remote GKrellMs independent config files in a shared home directory,
	   and for the hostname to show up in the X title for window management.
	-s, --server hostname
	   Run in client mode by connecting to and collecting data from a gkrellmd
	   server running on "hostname".
	-P, --port server_port
	   Use "server_port" for the gkrellmd server connection.
	-nc
	   No config mode.  The config menu is blocked so no config changes
	   can be made.  Useful in certain environments, or maybe for running
	   on a gdm login screen or during a screensaver mode?
	-demo
	   Force enabling of many monitors so themers can see everything. All
	   config saving is inhibited.
	-p, --plugin  plugin_under_test.so
	   For plugin development, load the command line specified plugin so you
	   can avoid repeated install steps in the development cycle.


Configuring GKrellM
===================

A right button mouse click on the side or top frames of the GKrellM
window will pop up a user configuration window where you can configure
all the builtin and plugin monitors.  Chart appearance may be configured
by right clicking on a chart, and right clicking on many panels will open
the configuration window directly to the corresponding monitor's
configuration page.


Using GKrellM - keeping an eye on your computers Id.
====================================================

Charts
======
The default for most charts is to automatically adjust the number of
grid lines drawn and the resolution per grid so drawn data will be
nicely visible.  You may change this to fixed grids of 1-5 and/or
fixed grid resolutions in the chart configuration windows.  However,
some combination of the auto scaling modes may give best results.

Auto grid resolution has the following behavior.

  If "Auto mode sticks at peak value" is not set:
    1) If using auto number of grids, set the resolution per grid and the
       number of grids to optimize the visibility of data drawn on the chart.
       Try to keep the number of grids between 1 and 7.
    2) If using a fixed number of grids, set the resolution per grid to the
       smallest value that draws data without clipping.

  If "Auto mode sticks at peak value" is set:
    1) If using auto number of grids, set the resolution per grid such that
       drawing the peak value encountered would require at least 5 grids.
    2) If using a fixed number of grids, set the resolution per grid such
       that the peak value encountered could be drawn without clipping.
       This means the resolution per grid never decreases.

All resolution per grid values are constrained to a set of values in
either a 1, 2, 5 sequence or a 1, 1.5, 2, 3, 5, 7 sequence.  If you set
"Auto mode sticks at peak value" a manual "Auto mode recalibrate" may
occasionally be required if the chart data has a wide dynamic range.


CPU Monitor
-----------
Data is plotted as a percentage.  In auto number of grids
mode, resolution is a fixed 20% per grid.  In fixed number of grids
mode, grid resolution is 100% divided by the number of grids.


Proc Monitor
------------
The krell shows process forks with a full scale value
of 10 forks.  The chart has a resolution of 10 forks/sec per grid
in auto number of grids mode and 50 forks/second maximum on the
chart in fixed number of grids mode.
The process load resolution per grid is best left at 1.0 for auto
number of grids, but can be set as high as 5 if you configure the
chart to have only 1 or 2 fixed grids.


Net Monitor
------------
GKrellM is designed to display a chart for net interfaces which are
up, which means they are listed in the routing table (however, it is
possible in some cases to monitor unrouted interfaces).
One net interface may be linked to a timer button which can be used
to connect and disconnect from an ISP.

The timer button shows an off, standby, or on state by a distinctive
(color or shape) icon.
ppp: Standby state is while the modem phone line is locked while
    ppp is connecting, and the on state is the ppp link connected.
    The phone line lock is determined by the existence of the modem
    lock file /var/lock/LCK..modem which assumes pppd is using
    /dev/modem.  However, if your pppd setup does not
    use /dev/modem, then you can configure an alternative with:
         ln  -s  /var/lock/LCK..ttySx   ~/.gkrellm2/LCK..modem
    where ttySx is the tty device your modem does use.  The ppp on
    state is detected by the existence of /var/run/pppX.pid and
    the time stamp of this file is the base for the on line time.
ippp: The timer button standby state is not applicable to isdn
    interfaces that are always routed. The on state is isdn on line
    while the ippp interface is routed.  The on line timer is reset
    at transitions from isdn hangup state to on line state.
For both ppp and ippp timer button links, the panel area of the
interface is always shown and the chart appears when the interface
is routed with the phone link connected or on line.

If the timer button is not linked to a net interface, then it can
be used as a push on / push off timer

Net monitors can have a label so that the interface can be
associated with the identity of the other end of the connection.
This is useful if you have several net connections or run multiple
remote gkrellms.  It can be easier to keep track of who is connected
to who.