1TH gkrellmd 1 "Oct 24, 2006" "GNU/Linux" "User’s Manual"
2gkrellmd − The GNU Krell Monitors Server
4[ ] [ ] [ | N ] [ | N ] [ | N ] [ | hostname ] [ | ] [ | name ] [
6| name ] [ ] [ ] [ | username ] [ | groupname ] [ seconds ] [
7seconds ] [ seconds ] [ mbox_path ] [ net_interface ] [ number ]
8Listens for connections from gkrellm clients. When a client con‐
10nects to a server all builtin monitors collect their data from
11the server. However, the process is running on the local ma‐
12chine, so plugins enabled in will collect data from the local
13context unless the plugin is client/server capable and has a
14plugin counterpart which is installed and enabled on the server.
15Enabling a plugin installed on a server requires adding a line to
16a file. Any command launching from a gkrellm client will run
17commands on the local machine. If you want to execute commands
18on the server, the client side commands can use ssh. There is no
19support for file system mounting on the machine where the server
20is running.
21Displays usage information and exits. Prints version and exits.
24Prints connection progress. Sets the data update frequency in
25samples per second for the server. This is independent of and
26should be less than the gkrellm client update rate. The rate can
27be from 1 to 10 and should be lower to minimize network traffic.
28A value of not much more than 1/2 the client update rate is best
29where it is not important to minimize network traffic. Sets the
30maximum number of simultaneous clients allowed to connect to the
31server. Use for the network connection. Specify hosts which are
32allowed to connect. Multiple arguments may be given. If no
33hosts are specified on the command line or in a gkrellmd.conf
34file, then all hosts are allowed to connect. The argument may be
35a text name or a IPv4 or IPv6 dotted notation. For IPv4, the
36simple subnet pattern x.y.z.* may be used. Also, if is the key‐
37word then all hosts are allowed. This option is additive and
38specified hosts will be added to the hostnames listed in
39gkrellmd.conf files unless the option is given first.
40For plugin development convenience, load and enable the command
42line specified plugin to avoid repeated install steps in the de‐
43velopment cycle. See the README from the gkrellm for more infor‐
44mation on gkrellmd plugin development. Requires at least
45gkrellmd version 2.2.0. Specify an installed plugin to enable
46(this is probably more convenient to specify in a gkrellmd.conf
47file). Requires at least gkrellmd version 2.2.0.
48Output a list of plugins which are installed and available to en‐
50able and exit. Requires at least gkrellmd version 2.2.0. Output
51a log of the plugin install process. When requesting a log, the
52option will have no effect. Requires at least gkrellmd version
532.2.0.
54Clears the current list of allowed hosts. Use this before any
56arguments if you want command line allowed hosts to override and
57not be additive to those specified in gkrellmd.conf files. Runs
58gkrellmd in the background and detaches from the terminal.
59Changes user to after startup. Useful if you want to run
60gkrellmd as root, but set it to run with another privileges; typ‐
61ically as the user. Changes group to after startup. The Inter‐
62net monitor defaults to reading TCP connections once per second.
63However, for Linux SMP kernels where reading /proc/net/tcp causes
64high cpu usage, the may be set to 1‐20 seconds to slow down
65/proc/net/tcp reads. Or set it to 0 to totally disable the In‐
66ternet monitor. Requires at least gkrellmd version 2.1.8. Con‐
67figure gkrellm clients to disconnect from a gkrellmd server if
68there is an interval where the client receives no input from the
69server. Use this for conditions where gkrellmd may be ungrace‐
70fully terminated such that socket connections are not closed.
71Minimum is 2 (less than 2 for no I/O disconnecting and is the de‐
72fault). Requires at least 2.1.8 versions of both gkrellmd and
73gkrellm. Configure gkrellm clients to attempt automatic recon‐
74nects to a gkrellmd server every seconds after a disconnected
75state is detected. Disconnected states are created by normal
76gkrellmd shutdowns or by an expiring Minimum is 2 (less than 2
77for no automatic reconnecting and is the default). Requires at
78least 2.1.8 versions of both gkrellmd and gkrellm. Check the
79server side mailbox and send mail counts to connected gkrellm
80clients. Mailbox types may be mbox, Maildir, and MH mail. Re‐
81quires at least 2.1.11 versions of both gkrellmd and gkrellm.
82Configure gkrellmd to send the connect time for a network inter‐
84face to all clients to be displayed in the client gkrellm timer
85button monitor display. If this is done, the client gkrellm
86timer button can still execute commands on the client, but the
87button will not affect the timer display. If you want the client
88timer button to execute commands on the server, your timer button
89commands can use ssh. So set this if your server box has say a
90ppp0 or ippp0 connection and you want to monitor its connect
91time. Requires at least 2.2.7 versions of both gkrellmd and
92gkrellm.
93If the mbmon daemon is running when gkrellmd is started, gkrellmd
95will connect to mbmon using the given port_number and send mbmon
96sensor data to connected gkrellm clients. The mbmon daemon
97should have been started using the same port number like so:
98On the server machine where gkrellmd is installed, copy the sam‐
101ple file from the subdirectory of the source tarball to one of
102the locations listed in the section and edit it to set your pref‐
103erences or to enable plugins. Probably don’t set the option un‐
104til you are happy with the configuration. Run: On a client ma‐
105chine, run: Configure the client gkrellm in its graphical config‐
106uration window as you wish, and that’s all there is to it. Of
107course, if you don’t use the default number you will have to sup‐
108ply an appropriate argument to the client Available plugins will
109be installed in the directory locations listed in the section.
110You may test enable any of these plugins with the option, but for
111permanent enabling you should add a line to any file listed in
112the section. Run to see a list of all installed plugins and run
113to see a log of the plugin install process.
114System server config which is read first. The config file may
116contain lines similar to the command line args. For example: al‐
117low‐host localhost allow‐host 127.0.0.1 allow‐host 192.168.0.*
118port 19150 max‐clients 2 update‐hz 2
119With the exception of command line args will override options in
121gkrellmd.conf files.
122Local server config file which is read second. User server con‐
124fig file which is read last. User server plugin directory. Sys‐
125tem wide server plugin directory. Local server plugin directory.
126Bill Wilson <billw@gkrellm.net>. http://www.gkrellm.net/
131