1 .\" <!-- $Id: courierlogger.sgml,v 1.9 2007/04/22 15:05:16 mrsam Exp $ -->
2 .\" <!-- Copyright 2004-2007 Double Precision, Inc. See COPYING for -->
3 .\" <!-- distribution information. -->
4 .\" Title: courierlogger
6 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
8 .\" Manual: Double Precision, Inc.
9 .\" Source: Double Precision, Inc.
11 .TH "COURIERLOGGER" "1" "08/23/2008" "Double Precision, Inc." "Double Precision, Inc."
12 .\" disable hyphenation
14 .\" disable justification (adjust text to left margin only)
17 courierlogger - Courier syslog wrapper
20 \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]]
25 is a wrapper that captures another process\'s error messages, and forwards them to the system logging facility,
28 There are two ways to use courierlogger:
31 \h'-04' 1.\h'+02'Use the shell to pipe another command\'s standard error, and/or its standard output, to
32 \fBcourierlogger\fR\'s standard input\.
36 \h'-04' 2.\h'+02'Alternatively,
38 itself can start another process, and arrange to have its standard error captured\.
43 In either case, each read line of text is sent as a syslog message\.
50 for sending messages to syslog\.
52 should be the application\'s name\.
55 \-facility=\fIsubsystem\fR
59 for classifying messages\. Your syslog facility uses
61 to determine which log messages are recorded in which log files\. The currently defined subsystems are:
64 \h'-04'\(bu\h'+03'auth
68 \h'-04'\(bu\h'+03'authpriv
72 \h'-04'\(bu\h'+03'console
76 \h'-04'\(bu\h'+03'cron
80 \h'-04'\(bu\h'+03'daemon
88 \h'-04'\(bu\h'+03'kern
96 \h'-04'\(bu\h'+03'mail
100 \h'-04'\(bu\h'+03'news
104 \h'-04'\(bu\h'+03'security
108 \h'-04'\(bu\h'+03'user
112 \h'-04'\(bu\h'+03'uucp
116 \h'-04'\(bu\h'+03'local0
120 \h'-04'\(bu\h'+03'local1
124 \h'-04'\(bu\h'+03'local2
128 \h'-04'\(bu\h'+03'local3
132 \h'-04'\(bu\h'+03'local4
136 \h'-04'\(bu\h'+03'local5
140 \h'-04'\(bu\h'+03'local6
144 \h'-04'\(bu\h'+03'local7
149 .nr an-no-space-flag 1
153 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\.
159 \fBcourierlogger\fR\'s process ID in
162 option is required when
168 is given without any of these,
175 Run as a daemon\. The
179 will quietly terminate if another
181 process is already running\. This is used to make sure that only one instance of
183 is running at the same time\. Specify a different filename with
185 to start a second copy of
193 if it terminates\. Normally
195 itself will terminate when
197 finishes running\. Use
199 to restart it instead\.
206 signal to the courierlogger process (as determined by examining the contents of the file specified by
207 \fBpid\fR), which will in turn send a
210 \fIprogram\fR\. Does nothing if courierlogger is not running\.
213 .nr an-no-space-flag 1
219 must be originally started with the
221 option if sending it a
223 causes it to terminate\.
225 The same thing may be accomplished by sending
236 signal to courierlogger, which in turn forwards it on to
239 does not terminate in 8 seconds, kill it with
243 \-user=\fIuser\fR, \-group=\fIgroup\fR
245 If running as root, change credentials to the given user and/or group, which may be given as names or numeric ids\.
247 When running a child program, it is started
249 privileges are dropped (unless the
251 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
255 options to work, you should configure the child program to drop its privileges to the same userid too\.
260 Drop root privileges before starting the child process\. The
264 options specify the non\-privileges userid and groupid\. Without the
266 option the child process remains a root process, and only the parent
268 process drops root privileges\.
271 \fIprogram\fR [ argument ] \.\.\.
273 If a program is given
275 will be started as a child process of
276 \fBcourierlogger\fR, capturing its standard error\. Otherwise,
278 reads message from standard input, and automatically terminates when standard input is closed\.
283 \fI\fBcouriertcpd\fR(1)\fR\&[1], your syslog man page\.