.\" <!-- distribution information. -->
.\" Title: courierlogger
.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
-.\" Date: 04/22/2007
+.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
+.\" Date: 08/23/2008
.\" Manual: Double Precision, Inc.
.\" Source: Double Precision, Inc.
.\"
-.TH "COURIERLOGGER" "1" "04/22/2007" "Double Precision, Inc." "Double Precision, Inc."
+.TH "COURIERLOGGER" "1" "08/23/2008" "Double Precision, Inc." "Double Precision, Inc."
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
-courierlogger \- Courier syslog wrapper
+courierlogger - Courier syslog wrapper
.SH "SYNOPSIS"
.HP 14
\fBcourierlogger\fR [\-name=\fItitle\fR] [\-facility=\fIsubsystem\fR] [\-pid=\fIfilename\fR] [\-user=\fIuser\fR] [\-group=\fIgroup\fR] [\-droproot] [[[\-respawn]\ [\-start]\ \fIprogram\fR\ [argument...]] | [\-stop] | [\-restart]]
.PP
\fBcourierlogger\fR
-is a wrapper that captures another process's error messages, and forwards them to the system logging facility,
-\(lqsyslog\(rq.
+is a wrapper that captures another process\'s error messages, and forwards them to the system logging facility,
+\(lqsyslog\(rq\.
.PP
There are two ways to use courierlogger:
+.sp
.RS 4
-\h'-04' 1.\h'+02'Use the shell to pipe another command's standard error, and/or its standard output, to
-\fBcourierlogger\fR's standard input.
+\h'-04' 1.\h'+02'Use the shell to pipe another command\'s standard error, and/or its standard output, to
+\fBcourierlogger\fR\'s standard input\.
.RE
+.sp
.RS 4
\h'-04' 2.\h'+02'Alternatively,
\fBcourierlogger\fR
-itself can start another process, and arrange to have its standard error captured.
+itself can start another process, and arrange to have its standard error captured\.
.RE
.sp
.RE
.PP
-In either case, each read line of text is sent as a syslog message.
+In either case, each read line of text is sent as a syslog message\.
.SH "OPTIONS"
.PP
\-name=\fItitle\fR
.RS 4
Use
\fItitle\fR
-for sending messages to syslog.
+for sending messages to syslog\.
\fItitle\fR
-should be the application's name.
+should be the application\'s name\.
.RE
.PP
\-facility=\fIsubsystem\fR
.RS 4
Use
\fIsubsystem\fR
-for classifying messages. Your syslog facility uses
+for classifying messages\. Your syslog facility uses
\fIsubsystem\fR
-to determine which log messages are recorded in which log files. The currently defined subsystems are:
+to determine which log messages are recorded in which log files\. The currently defined subsystems are:
+.sp
.RS 4
\h'-04'\(bu\h'+03'auth
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'authpriv
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'console
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'cron
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'daemon
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'ftp
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'kern
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'lpr
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'mail
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'news
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'security
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'user
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'uucp
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'local0
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'local1
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'local2
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'local3
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'local4
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'local5
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'local6
.RE
+.sp
.RS 4
\h'-04'\(bu\h'+03'local7
.RE
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBNote\fR
-Not all of the above facility names are implemented on every system. Check your system's syslog documentation for information on which facility names are allowed, and which log files record the corresponding messages for each facility.
+Note
+Not all of the above facility names are implemented on every system\. Check your system\'s syslog documentation for information on which facility names are allowed, and which log files record the corresponding messages for each facility\.
.RE
.PP
\-pid=\fIfilename\fR
.RS 4
Save
-\fBcourierlogger\fR's process ID in
-\fIfilename\fR. The
+\fBcourierlogger\fR\'s process ID in
+\fIfilename\fR\. The
\fI\-pid\fR
option is required when
\fI\-start\fR,
\fI\-stop\fR,
\fI\-restart\fR
-are given. If
+are given\. If
\fI\-pid\fR
is given without any of these,
\fI\-start\fR
-is assumed.
+is assumed\.
.RE
.PP
\-start
.RS 4
-Run as a daemon. The
+Run as a daemon\. The
\fBpid\fR
-option is required.
+option is required\.
\fBcourierlogger\fR
will quietly terminate if another
\fBcourierlogger\fR
-process is already running. This is used to make sure that only one instance of
+process is already running\. This is used to make sure that only one instance of
\fIprogram\fR
-is running at the same time. Specify a different filename with
+is running at the same time\. Specify a different filename with
\fBpid\fR
to start a second copy of
-\fIprogram\fR.
+\fIprogram\fR\.
.RE
.PP
\-respawn
.RS 4
Restart
\fIprogram\fR
-if it terminates. Normally
+if it terminates\. Normally
\fBcourierlogger\fR
itself will terminate when
\fIprogram\fR
-finishes running. Use
+finishes running\. Use
\fBrespawn\fR
-to restart it instead.
+to restart it instead\.
.RE
.PP
\-restart
\fBpid\fR), which will in turn send a
SIGHUP
to its child
-\fIprogram\fR. Does nothing if courierlogger is not running.
+\fIprogram\fR\. Does nothing if courierlogger is not running\.
.sp
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-\fBNote\fR
+Note
\fIprogram\fR
must be originally started with the
\fBrespawn\fR
option if sending it a
SIGHUP
-causes it to terminate.
+causes it to terminate\.
The same thing may be accomplished by sending
SIGHUP
to
\fBcourierlogger\fR
-itself.
+itself\.
.RE
.PP
\-stop
Send a
SIGTERM
signal to courierlogger, which in turn forwards it on to
-\fIprogram\fR. If
+\fIprogram\fR\. If
\fIprogram\fR
does not terminate in 8 seconds, kill it with
-SIGKILL.
+SIGKILL\.
.RE
.PP
\-user=\fIuser\fR, \-group=\fIgroup\fR
.RS 4
-If running as root, change credentials to the given user and/or group, which may be given as names or numeric ids.
+If running as root, change credentials to the given user and/or group, which may be given as names or numeric ids\.
.sp
When running a child program, it is started
\fIbefore\fR
privileges are dropped (unless the
\fB\-droproot\fR
-option is also given). This gives a means of starting a child as root so it can bind to a privileged port, but still have courierlogger run as a non\-root user. For the
+option is also given)\. This gives a means of starting a child as root so it can bind to a privileged port, but still have courierlogger run as a non\-root user\. For the
\fB\-stop\fR
and
\fB\-restart\fR
-options to work, you should configure the child program to drop its privileges to the same userid too.
+options to work, you should configure the child program to drop its privileges to the same userid too\.
.RE
.PP
\-droproot
.RS 4
-Drop root privileges before starting the child process. The
+Drop root privileges before starting the child process\. The
\fB\-user\fR
and
\fB\-group\fR
-options specify the non\-privileges userid and groupid. Without the
+options specify the non\-privileges userid and groupid\. Without the
\fB\-droproot\fR
option the child process remains a root process, and only the parent
\fBcourierlogger\fR
-process drops root privileges.
+process drops root privileges\.
.RE
.PP
-\fIprogram\fR [ argument ] ...
+\fIprogram\fR [ argument ] \.\.\.
.RS 4
If a program is given
\fIprogram\fR
will be started as a child process of
-\fBcourierlogger\fR, capturing its standard error. Otherwise,
+\fBcourierlogger\fR, capturing its standard error\. Otherwise,
\fBcourierlogger\fR
-reads message from standard input, and automatically terminates when standard input is closed.
+reads message from standard input, and automatically terminates when standard input is closed\.
.RE
.SH "SEE ALSO"
.PP
-\fI\fBcouriertcpd\fR(1)\fR\&[1], your syslog man page.
-.SH "REFERENCES"
+\fI\fBcouriertcpd\fR(1)\fR\&[1], your syslog man page\.
+.SH "NOTES"
.IP " 1." 4
\fBcouriertcpd\fR(1)
.RS 4
HCoop / hcoop / debian / courier-authlib.git / blobdiff