File nagircbot.1 of Package nagircbot

.TH NAGIRCBOT, 1 "July 2011" Linux "User Commands"
.SH NAME
nagircbot \- announce Nagios status to an IRC channel
.PP
.SH SYNOPSIS 
.B nagircbot -f 
.I /var/lib/nagios/status.dat
.B -X -s 
.I irc.freenode.net
.B -c
.I #Nagios-testing
.B -C -n
.I Nagiosbot
.B -U 
.I Nagios Bot 
.B -t -I 
.I 0
.B -d -z
.I nobody
.B -R -P
.I /var/run/nagircbot.pid
.SH DESCRIPTION
.PP
\fBnagircbot\fP is an IRC bot that reads Nagios' status information and
emits alerts to an IRC channel. It can filter alerts based on severity
(\fBCRITICAL\fP, \fBHARD\fP, \fBSOFT\fP, and/or \fBUNKNOWN\fP) or by regular
expression. It can connect to IRC servers protected by password or SSL, and
can optionally set the topic to the current Nagios status.
.SH OPTIONS
.HP
\fB\-f\fR     path to status.dat ('status_file' parameter in nagios.cfg)
.HP
\fB\-F\fR     host:port for retrieving status.dat over the network. If no port is 
specified, the default is 33333.
.HP
\fB\-x\fR     status.dat is in Nagios 1.0 format
.HP
\fB\-X\fR     status.dat is in Nagios 2.0/3.0 format
.HP
\fB\-s\fR     IRC server to connect to (host:port)
.HP
\fB\-c\fR     channel to connect to (#channel \- do not forget to escape the '#' in your shell)
.HP
\fB\-k\fR     keyword for the channel to connect to (default: no keyword)
.HP
\fB\-C\fR     use colors
.HP
\fB\-n\fR     nick
.HP
\fB\-u\fR     username (for logging into the irc server)
.HP
\fB\-U\fR     name (as seen by other users)
.HP
\fB\-p\fR     password (for logging into the irc server)
.HP
\fB\-N\fR     prefix for all in\-channel messages, e.g. for nick highlight
.HP
\fB\-m\fR     display all information on separate lines
.HP
\fB\-t\fR     show a summary in the topic\-line
.HP
\fB\-i\fR     check interval (in seconds \- default 60)
.HP
\fB\-I\fR     how often to announce the global status in the channel (in seconds, 0 for off)
.IP
do not set it smaller then the \fB\-i\fR value
.PP
.HP
\fB\-d\fR     do not fork into the background
.HP
\fB\-T\fR x   checks to see if Nagios is still running. comma\-seperated list
.IP
(without spaces!) with the following elements:
max_time_last_host_update, max_time_oldest_host_update,
max_time_last_host_check, max_time_oldest_host_check,
max_time_last_service_check, max_time_oldest_service_check,
max_time_oldest_next_service_check
send 'check' in a private message to invoke the check
.PP
\fB\-z\fR user user to run as
.HP
\fB\-H\fR     show only state type 'HARD' (default)
.HP
\fB\-S\fR     show also state type 'SOFT'
.HP
\fB\-R\fR     only announce CRITICAL/UNKNOWN errors on the channel
.HP
\fB\-A\fR x   filter (omit) lines that match with the given regular expression
.HP
\fB\-P\fR x   write pid to file x
.HP
\fB\-e\fR     Use encryption (SSL) (default: no)
.SH AUTHOR
nagircbot was written by Folkert van Heusden <folkert@vanheusden.com>
.SH VERSION
Version 0.0.33 (C) 2006-2011