2 .\" <!-- Copyright 2004-2007 Double Precision, Inc. See COPYING for -->
3 .\" <!-- distribution information. -->
4 .\" Title: courierlogger
5 .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
6 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
8 .\" Manual: Double Precision, Inc.
9 .\" Source: Double Precision, Inc.
12 .TH "COURIERLOGGER" "1" "08/25/2013" "Double Precision, Inc." "Double Precision, Inc."
13 .\" -----------------------------------------------------------------
14 .\" * Define some portability stuff
15 .\" -----------------------------------------------------------------
16 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17 .\" http://bugs.debian.org/507673
18 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
19 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
22 .\" -----------------------------------------------------------------
23 .\" * set default formatting
24 .\" -----------------------------------------------------------------
25 .\" disable hyphenation
27 .\" disable justification (adjust text to left margin only)
29 .\" -----------------------------------------------------------------
30 .\" * MAIN CONTENT STARTS HERE *
31 .\" -----------------------------------------------------------------
33 courierlogger \- Courier syslog wrapper
35 .HP \w'\fBcourierlogger\fR\ 'u
36 \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]]
40 is a wrapper that captures another process\*(Aqs error messages, and forwards them to the system logging facility,
43 There are two ways to use courierlogger:
53 Use the shell to pipe another command\*(Aqs standard error, and/or its standard output, to
54 \fBcourierlogger\fR\*(Aqs standard input\&.
67 itself can start another process, and arrange to have its standard error captured\&.
70 In either case, each read line of text is sent as a syslog message\&.
77 for sending messages to syslog\&.
79 should be the application\*(Aqs name\&.
82 \-facility=\fIsubsystem\fR
86 for classifying messages\&. Your syslog facility uses
88 to determine which log messages are recorded in which log files\&. The currently defined subsystems are:
326 .nr an-no-space-flag 1
333 Not all of the above facility names are implemented on every system\&. Check your system\*(Aqs syslog documentation for information on which facility names are allowed, and which log files record the corresponding messages for each facility\&.
341 \fBcourierlogger\fR\*(Aqs process ID in
342 \fIfilename\fR\&. The
344 option is required when
350 is given without any of these,
357 Run as a daemon\&. The
359 option is required\&.
361 will quietly terminate if another
363 process is already running\&. This is used to make sure that only one instance of
365 is running at the same time\&. Specify a different filename with
367 to start a second copy of
375 if it terminates\&. Normally
377 itself will terminate when
379 finishes running\&. Use
381 to restart it instead\&.
388 signal to the courierlogger process (as determined by examining the contents of the file specified by
389 \fBpid\fR), which will in turn send a
392 program\&. Does nothing if courierlogger is not running\&.
398 .nr an-no-space-flag 1
406 must be originally started with the
408 option if sending it a
410 causes it to terminate\&.
413 The same thing may be accomplished by sending
424 signal to courierlogger, which in turn forwards it on to
427 does not terminate in 8 seconds, kill it with
431 \-user=\fIuser\fR, \-group=\fIgroup\fR
433 If running as root, change credentials to the given user and/or group, which may be given as names or numeric ids\&.
435 When running a child program, it is started
437 privileges are dropped (unless the
439 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
443 options to work, you should configure the child program to drop its privileges to the same userid too\&.
448 Drop root privileges before starting the child process\&. The
452 options specify the non\-privileges userid and groupid\&. Without the
454 option the child process remains a root process, and only the parent
456 process drops root privileges\&.
459 \fIprogram\fR [ argument ] \&.\&.\&.
461 If a program is given
463 will be started as a child process of
464 \fBcourierlogger\fR, capturing its standard error\&. Otherwise,
466 reads message from standard input, and automatically terminates when standard input is closed\&.
470 \m[blue]\fB\fBcouriertcpd\fR(1)\fR\m[]\&\s-2\u[1]\d\s+2, your syslog man page\&.
475 \%[set $man.base.url.for.relative.links]/couriertcpd.html