removed top level directory

1 files changed, 145 insertions, 0 deletions

diff --git a/man/qmail-mrtg.8 b/man/qmail-mrtg.8
new file mode 100644
index 0000000..165c0d5
--- /dev/null
+++ b/man/qmail-mrtg.8
@@ -0,0 +1,145 @@
+.TH s/qmail: qmail-mrtg 8
+
+.SH NAME
+qmail-mrtg \- prepare s/qmail logs for MRTG analysis
+.SH SYNOPSIS
+.B qmail-mrtg  [ -1 | -2 | -3 | -4 | -5 | -6 | -a | -b | -c | -d | -e | -f | -g | -h | -i | -j | k | -z | -A | -B ] [time]
+
+.SH DESCRIPTION
+.B qmail-mrtg
+reads the 
+.B multilog
+tagged 
+.B s/qmail 
+logs with TAI64N timestamps on standard input 
+to produce a counter for specifc 
+.B s/qmail 
+events and display them on standard output
+suitable for MRTG processing.
+
+.SH USAGE
+.B qmail-mrtg
+can be used to analyse 
+.BR qmail-send ,
+.BR qmail-smtpd ,
+and
+.B qmail-pop3d
+logs in order to feed the results into MRTG. 
+
+Typically,
+.B qmail-mrtg
+is called by the 
+.B crontab
+facility together with a configuration files telling
+.B qmail-mrtg
+what to analyse.
+
+.SH ARGUMENTS
+.B qmail-mrtg
+posses three different sets of commands.
+Reading
+.B qmail-send
+logs:
+.I -1 
+Deliveries/TLS transmitted,
+.I -2  
+Message KBytes enqueued,
+.I -3 
+Local/Remote Concurrency, 
+.I -4
+Failure/Deferred Messages,
+.I -5 
+Bounces/Triple bounces,
+.I -6 
+qmtp/qmtps Messages.
+
+.B qmail-smtpd
+logs:
+.I -a 
+total sessions,
+.I -b 
+accepted/rejected sessions,
+.I -c 
+rejected sessions (MTA),
+.I -d 
+rejected originator,
+.I -e 
+rejected recipient,
+.I -f 
+rejected data (Mime + Loader),
+.I -g 
+rejected data (Virus + Spam),
+.I -h 
+authenticated sessions, 
+.I -i 
+accepted/rejected TLS sessions,
+.I -j 
+recognized/rejected SPF sessions.
+.I -k 
+deferred SMTP sessions (greylisted).
+Summaries are provided by
+.I -z 
+total sessions, including 
+.B qmail-smtpd 
+and
+.BR tcpserver /
+.BR sslserver /
+.BR rblsmtpd .
+
+.BR qmail-pop3d /
+.B qmail-popup
+logs:
+.I -A 
+accepted/rejected POP3 user,
+.I -B 
+.BR qmail-pop3d / 
+.BR tcpserver /
+.B sslserver 
+connections.
+
+The intervals to evaluate the information given on STDIN 
+defaults to
+.IR 305\ secs
+and can be changed by the second argument for 
+.B qmail-mrtg
+providing a value as
+.I minutes
+increased by an offset of 5 sec to cover a roll-over
+cut-off by 
+.BR crontab .
+.SH "CONFIGURATION FILES"
+.B qmail-mrtg
+depends on a configuration file for each service.
+Sample configuration files are provided.
+
+.SH "CRON INVOCATION"
+Since 
+.B qmail-mrtg
+typically is invoked by the
+.B cron 
+facility, additional information neeeds to be supplied:
+
+.EX
+  */5 * * * * env LANG=C mrtg /etc/qmail-mrtg.send.cfg &>/dev/null
+  */5 * * * * env LANG=C mrtg /etc/qmail-mrtg.smtpd.cfg &>/dev/null
+  */5 * * * * env LANG=C mrtg /etc/qmail-mrtg.pop3d.cfg &>/dev/null
+.EE
+
+Note: The default interval of 
+.IR 305\ secs
+allows a certain overlap for cron not to loose events at the very
+edge.
+
+.SH "CREDITS"
+.B MRTG
+is a program created by Tobias Oetiker and Dave Rand
+(http://oss.oetiker.ch/mrtg/).
+
+.SH "SEE ALSO"
+mrtg(1),
+crontab(5),
+cron(8),
+qmail-log(8),
+qmail-send(8),
+qmail-smtpd(8),
+qmail-popup(8).