1gkrellmd(1) User's Manual gkrellmd(1)
2
6 gkrellmd - The GNU Krell Monitors Server
7
10 gkrellmd [ --help ] [ --verbose ] [ -u | --update-hz f ] [ -m | --max-
11 clients N ] [ -A | --address server_address ] [ -P | --port server_port
12 ] [ -a | --allow-host hostname ] [ -d | --detach ] [ -p | --plugin name
13 ] [ -pe | --plugin-enable name ] [ --plist ] [ --plog ] | --logfile
14 path ] | --syslog ] [ -U | --user username ] [ -G | --group groupname ]
15 [ --pidfile path ] [ --inet-interval seconds ] [ --io-timeout seconds ]
16 [ --reconnect-timeout seconds ] [ --mailbox mbox_path ] [ --net-timer
17 net_interface ] [ --mbmon-port number ]
18
21 gkrellmd Listens for connections from gkrellm clients. When a gkrellm
22 client connects to a gkrellmd server all builtin monitors collect their
23 data from the server. However, the gkrellm process is running on the
24 local machine, so plugins enabled in gkrellm will collect data from the
25 local context unless the plugin is client/server capable and has a
26 gkrellmd plugin counterpart which is installed and enabled on the
27 server. Enabling a gkrellmd plugin installed on a server requires
28 adding a plugin-enable line to a gkrellmd.conf file.
29 Any command launching from a gkrellm client will run commands on the
31 local machine. If you want to execute commands on the server, the
32 client side commands can use ssh.
33 There is no support for file system mounting on the machine where the
35 gkrellmd server is running.
36
40 -h --help
41 Displays usage information and exits.
42 -v --version
44 Prints gkrellmd version and exits.
45 -V --verbose
47 Prints connection progress.
48 -u, --update-hz f
50 Sets the data update frequency in samples per second for the
51 server. This is independent of and should be less than the
52 gkrellm client update rate. The rate can be from 1 to 10 and
53 should be lower to minimize network traffic. A value of not
54 much more than 1/2 the client update rate is best where it is
55 not important to minimize network traffic.
56 -m, --max-clients N
58 Sets the maximum number of simultaneous clients allowed to con‐
59 nect to the server.
60 -A, --address server_address
62 Use server_address for the network connection.
63 -P, --port server_port
65 Use server_port for the network connection.
66 -a, --allow-host hostname
68 Specify hosts which are allowed to connect. Multiple allow-host
69 arguments may be given. If no hosts are specified on the com‐
70 mand line or in a gkrellmd.conf file, then all hosts are allowed
71 to connect. The hostname argument may be a text name or a IPv4
72 or IPv6 dotted notation. For IPv4, the simple subnet pattern
73 x.y.z.* may be used. Also, if hostname is the keyword ALL then
74 all hosts are allowed. This option is additive and specified
75 hosts will be added to the hostnames listed in gkrellmd.conf
76 files unless the --clear-hosts option is given first.
77 -p, --plugin name
80 For plugin development convenience, load and enable the command
81 line specified plugin to avoid repeated install steps in the
82 development cycle. See the README from the gkrellm demo5 for
83 more information on gkrellmd plugin development. Requires at
84 least gkrellmd version 2.2.0.
85 -pe, --plugin-enable name
87 Specify an installed plugin to enable (this is probably more
88 convenient to specify in a gkrellmd.conf file). Requires at
89 least gkrellmd version 2.2.0.
90 -plist Output a list of plugins which are installed and available to
93 enable and exit. Requires at least gkrellmd version 2.2.0.
94 -plog Output a log of the plugin install process. When requesting a
96 log, the --detach option will have no effect. Requires at least
97 gkrellmd version 2.2.0.
98 -l, --logfile path
100 Enable sending error and debugging messages to a log file.
101 --syslog
103 Enable sending logging messages to the syslog file.
104 -c, --clear-hosts
107 Clears the current list of allowed hosts. Use this before any
108 --allow-host arguments if you want command line allowed hosts to
109 override and not be additive to those specified in gkrellmd.conf
110 files.
111 -d, --detach
113 Runs gkrellmd in the background and detaches from the terminal.
114 -U, --user username
116 Changes user to username after startup. Useful if you want to
117 run gkrellmd as root, but set it to run with another privileges;
118 typically as the nobody user.
119 -G, --group groupname
121 Changes group to groupname after startup.
122 --pidfile path
124 Create a PID file for the running gkrellmd. Typically, path
125 would be /var/run/gkrellmd.pid. Default is no PID file.
126 --inet-interval seconds
128 The Internet monitor defaults to reading TCP connections once
129 per second. However, for Linux SMP kernels where reading
130 /proc/net/tcp causes high cpu usage, the inet-interval may be
131 set to 1-20 seconds to slow down /proc/net/tcp reads. Or set it
132 to 0 to totally disable the Internet monitor. Requires at least
133 gkrellmd version 2.1.8.
134 --io-timeout seconds
136 Configure gkrellm clients to disconnect from a gkrellmd server
137 if there is an io-timeout interval where the client receives no
138 input from the server. Use this for conditions where gkrellmd
139 may be ungracefully terminated such that socket connections are
140 not closed. Minimum is 2 (less than 2 for no I/O disconnecting
141 and is the default). Requires at least 2.1.8 versions of both
142 gkrellmd and gkrellm.
143 --reconnect-timeout seconds
145 Configure gkrellm clients to attempt automatic reconnects to a
146 gkrellmd server every reconnect-timeout seconds after a discon‐
147 nected state is detected. Disconnected states are created by
148 normal gkrellmd shutdowns or by an expiring io-timeout. Minimum
149 is 2 (less than 2 for no automatic reconnecting and is the
150 default). Requires at least 2.1.8 versions of both gkrellmd and
151 gkrellm.
152 --mailbox mbox_path
154 Check the server side mailbox mbox_path and send mail counts to
155 connected gkrellm clients. Mailbox types may be mbox, Maildir,
156 and MH mail. Requires at least 2.1.11 versions of both gkrellmd
157 and gkrellm.
158 --net-timer net_interface
161 Configure gkrellmd to send the connect time for a network inter‐
162 face to all clients to be displayed in the client gkrellm timer
163 button monitor display. If this is done, the client gkrellm
164 timer button can still execute commands on the client, but the
165 button will not affect the timer display. If you want the
166 client timer button to execute commands on the server, your
167 timer button commands can use ssh. So set this if your server
168 box has say a ppp0 or ippp0 connection and you want to monitor
169 its connect time. Requires at least 2.2.7 versions of both
170 gkrellmd and gkrellm.
171 --mbmon-port port_number
174 If the mbmon daemon is running when gkrellmd is started,
175 gkrellmd will connect to mbmon using the given port_number and
176 send mbmon sensor data to connected gkrellm clients. The mbmon
177 daemon should have been started using the same port number like
178 so: mbmon -r -P port_number
179
183 On the server machine where gkrellmd is installed, copy the sample
184 gkrellmd.conf file from the server subdirectory of the gkrellm source
185 tarball to one of the gkrellmd.conf locations listed in the FILES sec‐
186 tion and edit it to set your preferences or to enable plugins. Proba‐
187 bly don't set the detached option until you are happy with the configu‐
188 ration. Run: gkrellmd
189 On a client machine, run: gkrellm -s server-machine-name
191 Configure the client gkrellm in its graphical configuration window as
193 you wish, and that's all there is to it. Of course, if you don't use
194 the default gkrellmd port number you will have to supply an appropriate
195 port argument to the client gkrellm.
196 Available plugins will be installed in the plugins-gkrellmd directory
198 locations listed in the FILES section. You may test enable any of
199 these plugins with the -pe option, but for permanent enabling you
200 should add a plugin-enable line to any gkrellmd.conf file listed in the
201 FILES section. Run gkrellmd -plist to see a list of all installed
202 plugins and run gkrellmd -plog to see a log of the plugin install
203 process.
204
207 /etc/gkrellmd.conf
208 System server config which is read first. The config file may
209 contain lines similar to the command line args. For example:
210 allow-host localhost
212 allow-host 127.0.0.1
214 allow-host 192.168.0.*
216 port 19150
218 max-clients 2
220 update-hz 2
222 detach
224 io-timeout 5
226 reconnect-timeout 5
228 plugin-enable gkrelltopd
230 With the exception of --allow-host, command line args will over‐
233 ride options in gkrellmd.conf files.
234 /usr/local/etc/gkrellmd.conf
237 Local server config file which is read second.
238 ~/.gkrellmd.conf
240 User server config file which is read last.
241 ~/.gkrellm2/plugins-gkrellmd
243 User server plugin directory.
244 /usr/lib64/gkrellm2/plugins-gkrellmd
246 System wide server plugin directory.
247 /usr/local/lib64/gkrellm2/plugins-gkrellmd
249 Local server plugin directory.
250
254 This manual page was written by Bill Wilson <billw@gkrellm.net>.
255 http://www.gkrellm.net/
256GNU/Linux Oct 14, 2014 gkrellmd(1)