.\" This manpage has been automatically generated by docbook2man 
.\" from a DocBook document.  This tool can be found at:
.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
.\" Please send any bug reports, improvements, comments, patches, 
.\" etc. to Steve Cheng <steve@ggi-project.org>.
.TH "NETMRG-GATHERER" "1" "11 April 2008" "" "Manual Pages"

.SH NAME
netmrg-gatherer \- Gathers data from devices.
.SH SYNOPSIS

\fBnetmrg-gatherer\fR [ \fBOPTIONS\fR ]

.SH "DESCRIPTION"
.PP
\fBnetmrg-gatherer\fR performs tests on all enabled hosts in NetMRG.  It will store results in RRD files using RRDTOOL(1) and perform actions in response to events.
.SS "GLOBAL OPTIONS"
.TP
\fB   -h  \fR
Displays usage information and exits.
.TP
\fB   -v  \fR
Displays software version and exits.
.SS "OPERATING OPTIONS"
.TP
\fB   -t \fInum threads\fB  \fR
Run no more than the specified number of threads simultaneously.
.TP
\fB   -X  \fR
Become a daemon.
.TP
\fB   -M \fImode\fB  \fR
Mode of operation.  This option controls the manner in which the gatherer operates.  The modes currently supported are "once" (the default, best used manually or via cron) which runs all tests once then exits, and "wait" (best used when daemonized) which will run all tests, wait for the gatherer interval to expire, and then repeat.
.sp
.RS
.B "Note:"
To run \fBnetmrg-gatherer\fR daemonized, the recommended set of options at this point is "-X -S -M wait" which will daemonize, repeat the gather cycle on each interval, and write output to syslog.
.RE
.SS "LOGGING, DEBUGGING AND VERBOSITY OPTIONS"
.TP
\fB   -S  \fR
Syslog.  Logs messages to syslog instead of stdout.
.TP
\fB   -b  \fR
Bland.  Disables color output.  By default, \fBnetmrg-gatherer\fR will display color output when connected to a terminal, but will use bland output when its output is written to a file.  This option should only be needed when the detection mechanism has failed, or the user doesn't want to see colors when running the program by hand.
.TP
\fB   -a  \fR
All.  Displays all log messages.
.TP
\fB   -m  \fR
Most.  Displays more messages than default.
.TP
\fB   -q  \fR
Quiet.  Silences all output.
.TP
\fB   -l \fIlevel mask\fB  \fR
Only outputs messages that match the specified level mask.
.TP
\fB   -c \fIcomponent mask\fB  \fR
Only outputs messages that match the specified component mask.
.TP
\fB   -s  \fR
Safe.  Tries to keep sensitive information out of the displayed messages.
.SS "CONFIGURATION FILE OPTIONS"
.TP
\fB   -C \fIconfig file\fB  \fR
Uses the specified XML configuration file.
.TP
\fB   -K \fIconfig file\fB  \fR
Parses the specified XML configuration file and exits.
.SS "DATABASE OPTIONS"
.TP
\fB   -H \fIhost\fB  \fR
Uses the specified host name for connecting to the database.
.TP
\fB   -D \fIdatabase\fB  \fR
Uses the specified database name.
.TP
\fB   -u \fIuser name\fB  \fR
Uses the specified user name for connecting to the database.
.TP
\fB   -p  [ \fIpassword\fB ]  \fR
Uses the specified password for connecting to the database.  If no password is specified, the user is prompted to enter one.
.SS "RECACHING OPTIONS"
.TP
\fB   -i \fIdevice id\fB  \fR
Performs an interface recache on the specified device.
.TP
\fB   -d \fIdevice id\fB  \fR
Performs a disk recache on the specified device.
.sp
.RS
.B "Note:"
Recaching options are intended for use by the web interface.  These options should not be generally used by end users.
.RE