From 086f821b7049abf10d70c6413ac1cf928257e7cf Mon Sep 17 00:00:00 2001 From: Rainer Gerhards Date: Wed, 12 Oct 2005 10:51:49 +0000 Subject: added man page for rfc3195d --- rfc3195d.8 | 79 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 rfc3195d.8 (limited to 'rfc3195d.8') diff --git a/rfc3195d.8 b/rfc3195d.8 new file mode 100644 index 00000000..82ecbd32 --- /dev/null +++ b/rfc3195d.8 @@ -0,0 +1,79 @@ +.\" Copyright 2005 Rainer Gerhards and Adiscon for the rsyslog modifications +.\" Distributed under the GNU General Public License. +.\" +.TH RSYSLOGD 8 "12 October 2005" "Version 1.11.0 (unstable)" "Linux System Administration" +.SH NAME +rfc3195d \- RFC 3195 listener +.SH SYNOPSIS +.B rfc3195d +.RB [ " \-d " ] +.RB [ " \-p" +.IB socket +] +.RB [ " \-v " ] +.LP +.SH DESCRIPTION +.B Rfc3195d +is a utility for receiving syslog messages via RFC 3195. Both +RAW and COOKED profiles are supported (but COOKED only without +relay-specific PATH elements). +rfc3195d accepts messages via RFC 3195 and forwards them to +the local domain socket specified in the -p option +(/dev/log3195 by default). There, the messages can be picked up +by the system syslogd. While rfc3195d can work with any syslogd, +we highly recommend using +.B rsyslogd, +because it has special handling +for the messages forwarded by rfc3195d. To enable message +reception in +.B rsyslogd, +use the "-a :/dev/log3195" command line +option (the colon in front of the socket name tells +.B rsyslogd +that the messages contain hostnames - this is vital to get the +right sender name into your logs). + +.B Rfc3195d +currently has very limited functionality. Most importantly, +it does not allow to limit the senders it receives messages from. +Documentation is also very sparse. The situation should improve over +time as the rsyslog project is continously being enhanced. +.LP +.SH OPTIONS +.TP +.BI "\-p " "socket" +The socket the received messages are to be sent to. If not specified, +/dev/log3195 is used. +.TP +.B "\-d" +Turns on debug mode. In it, rfc3195d spits out diagnostic information +to stdout. +.TP +.B "\-v" +Print version and exit. +.SH SIGNALS +.B Rfc3195d +reacts to a set of signals. +.TP +.B SIGTERM +.B Rfc3195d +terminates. +.TP +.B SIGUSR1 +.B Rfc3195d +terminates. +.LP +.SH SEE ALSO +.BR rsyslog.conf (5), +.BR rsyslogd (8) +.LP +.SH MORE INFORMATION +Is available on the project home page at http://www.rsyslog.com +.LP +.SH COLLABORATORS +Rfc3195d uses liblogging (http://www.liblogging.org) for RFC 3195 +protocol handling. +.PD 0 +.TP +Rainer Gerhards +.zZ -- cgit