Displaying Document: documentation/USAGE [ Download ]/*--------------------------------------------------------------
NetLoadD - Network Load Deamon Read The
David Cutting (dcutting@purplepixie.org) L I C E N C E
--------------------------------------------------------------*/
USAGE: Using NetLoadD (1.5.1)
NetLoadD is started from the command line with a variety
of options as follows:
netloadd [+/-switches] [f config file] [d delay] interface
for example:
netloadd -mysql f/etc/netloadd.conf d60 eth0
would start netload without MySQL by default using the
config file /etc/netloadd.conf polling the device
eth0 every 60 seconds.
Please note that command-line options are parsed
in sequence and the last seen setting will be used. In
our example above, if the netloadd.conf file enables
MySQL it will be used at runtime. An example of this
would be:
netloadd d20 d30 d40 d50 d60 eth0
which would start eth0 having finally configured the
delay to 60 seconds.
The vast majority of netloadd functionality can be
utilised from the command line, the notable exception
being MySQL support which although enableable from
the command line must have Server data provided in
a configuration file.
For full details of the format of the configuration
file, please see the CONFIG document.
Enablable +/- switches (use + or - with the option
eg +q or +quitonerror to turn Quit on Error on and
-q to turn it off). Most switches have a full name
and a quicktag (such as Quit On Error having the
full name quitonerror and a quicktag of q).
Switches are as follows:
+/- debug or d Turns verbose debug mode
on or off. This feature
will put a lot of information
onto the screen (and
optionally the syslog if
syslog mode enabled).
+/- syslog Turns syslog report output
on or off.
+/- quitonerror or q Turn the Quit on Error feature
on or off. If QuitOnError is set,
the program will terminate if
it does not find the device during
a scan as well as on most other
non-fatal warning-type errors.
Disabling this feature will not
stop the program exiting if the
device is not present at startup
but allows the system to ignore
events such as reconnections.
+/- commentary or c Turns on or off the console
commentary mode. With debug mode
off and the commentary disabled the
program is silent to the console save
for fatal errors and suitable for use
as a full system daemon.
+/- file Turns on or off the default file
output feature. When this feature
is enabled from the second poll onward
the details are recorded into the
file /tmp/netloadd.DEV for example:
/tmp/netloadd.eth0
+/- help or h This switch can be used with either
polarity. Used on its own the program
displays help and exits, when used with
a valid command line it will just
display its help in startup.
+/- exit or x Produces a fatal error in the config
stream. This is useful in development
to test configuration settings without
starting an actual run for example:
netloadd +c +mysql +d +h +x eth0
+/- mysql Enable or disable MySQL. If enabled
this must be used with a configuration
file containing the account data
(alternatively the default values can
be built in at compile time).
In addition to the switches there are the delay (d) and
file (f) options. These are used on their own and immediately
followed by a paremeter (without whitespace) of the delay
in seconds or configuration filename respectively. For
example:
netloadd d60 f/etc/netloadd.conf eth0
would start netloadd for eth0 with a delay of 60 seconds
using /etc/netloadd.conf as a configuration file. For
information on using the configuration file please see
the CONFIG document.
Default values for the system can be set at oompile time
and details of this are included at the INSTALL document.
|
