Patrick Welche <prlw1@cam.ac.uk>
[netbsd-mini2440.git] / external / ibm-public / postfix / dist / man / man1 / postlog.1
blob275828f9292e858021f08e0aaaa0e175c2d65b62
1 .\"     $NetBSD$
2 .\"
3 .TH POSTLOG 1 
4 .ad
5 .fi
6 .SH NAME
7 postlog
8 \-
9 Postfix-compatible logging utility
10 .SH "SYNOPSIS"
11 .na
12 .nf
13 .fi
14 .ad
15 \fBpostlog\fR [\fB-iv\fR] [\fB-c \fIconfig_dir\fR]
16 [\fB-p \fIpriority\fB] [\fB-t \fItag\fR] [\fItext...\fR]
17 .SH DESCRIPTION
18 .ad
19 .fi
20 The \fBpostlog\fR(1) command implements a Postfix-compatible logging
21 interface for use in, for example, shell scripts.
23 By default, \fBpostlog\fR(1) logs the \fItext\fR given on the command
24 line as one record. If no \fItext\fR is specified on the command
25 line, \fBpostlog\fR(1) reads from standard input and logs each input
26 line as one record.
28 Logging is sent to \fBsyslogd\fR(8); when the standard error stream
29 is connected to a terminal, logging is sent there as well.
31 The following options are implemented:
32 .IP "\fB-c \fIconfig_dir\fR"
33 Read the \fBmain.cf\fR configuration file in the named directory
34 instead of the default configuration directory.
35 .IP \fB-i\fR
36 Include the process ID in the logging tag.
37 .IP "\fB-p \fIpriority\fR"
38 Specifies the logging severity: \fBinfo\fR (default), \fBwarn\fR,
39 \fBerror\fR, \fBfatal\fR, or \fBpanic\fR.
40 .IP "\fB-t \fItag\fR"
41 Specifies the logging tag, that is, the identifying name that
42 appears at the beginning of each logging record. A default tag
43 is used when none is specified.
44 .IP \fB-v\fR
45 Enable verbose logging for debugging purposes. Multiple \fB-v\fR
46 options make the software increasingly verbose.
47 .SH "ENVIRONMENT"
48 .na
49 .nf
50 .ad
51 .fi
52 .IP MAIL_CONFIG
53 Directory with the \fBmain.cf\fR file.
54 .SH "CONFIGURATION PARAMETERS"
55 .na
56 .nf
57 .ad
58 .fi
59 The following \fBmain.cf\fR parameters are especially relevant to
60 this program.
62 The text below provides only a parameter summary. See
63 \fBpostconf\fR(5) for more details including examples.
64 .IP "\fBconfig_directory (see 'postconf -d' output)\fR"
65 The default location of the Postfix main.cf and master.cf
66 configuration files.
67 .IP "\fBsyslog_facility (mail)\fR"
68 The syslog facility of Postfix logging.
69 .IP "\fBsyslog_name (see 'postconf -d' output)\fR"
70 The mail system name that is prepended to the process name in syslog
71 records, so that "smtpd" becomes, for example, "postfix/smtpd".
72 .SH "SEE ALSO"
73 .na
74 .nf
75 postconf(5), configuration parameters
76 syslogd(8), syslog daemon
77 .SH "LICENSE"
78 .na
79 .nf
80 .ad
81 .fi
82 The Secure Mailer license must be distributed with this software.
83 .SH "AUTHOR(S)"
84 .na
85 .nf
86 Wietse Venema
87 IBM T.J. Watson Research
88 P.O. Box 704
89 Yorktown Heights, NY 10598, USA