summaryrefslogtreecommitdiffstats
path: root/man/man1/postlog.1
blob: d9723e7c4e31985d45bc8f67c532082c6ef1b6d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
.TH POSTLOG 1 
.ad
.fi
.SH NAME
postlog
\-
Postfix\-compatible logging utility
.SH "SYNOPSIS"
.na
.nf
.fi
.ad
\fBpostlog\fR [\fB\-iv\fR] [\fB\-c \fIconfig_dir\fR]
[\fB\-p \fIpriority\fR] [\fB\-t \fItag\fR] [\fItext...\fR]
.SH DESCRIPTION
.ad
.fi
The \fBpostlog\fR(1) command implements a Postfix\-compatible logging
interface for use in, for example, shell scripts.

By default, \fBpostlog\fR(1) logs the \fItext\fR given on the command
line as one record. If no \fItext\fR is specified on the command
line, \fBpostlog\fR(1) reads from standard input and logs each input
line as one record.

By default, logging is sent to \fBsyslogd\fR(8) or
\fBpostlogd\fR(8); when the
standard error stream is connected to a terminal, logging
is sent there as well.

The following options are implemented:
.IP "\fB\-c \fIconfig_dir\fR"
Read the \fBmain.cf\fR configuration file in the named directory
instead of the default configuration directory.
.IP "\fB\-i\fR (obsolete)"
Include the process ID in the logging tag. This flag is ignored as
of Postfix 3.4, where the PID is always included.
.IP "\fB\-p \fIpriority\fR (default: \fBinfo\fR)"
Specifies the logging severity: \fBinfo\fR, \fBwarn\fR,
\fBerror\fR, \fBfatal\fR, or \fBpanic\fR. With Postfix 3.1
and later, the program will pause for 1 second after reporting
a \fBfatal\fR or \fBpanic\fR condition, just like other
Postfix programs.
.IP "\fB\-t \fItag\fR"
Specifies the logging tag, that is, the identifying name that
appears at the beginning of each logging record. A default tag
is used when none is specified.
.IP \fB\-v\fR
Enable verbose logging for debugging purposes. Multiple \fB\-v\fR
options make the software increasingly verbose.
.SH "SECURITY"
.na
.nf
.ad
.fi
The \fBpostlog\fR(1) command is designed to run with
set\-groupid privileges, so that it can connect to the
\fBpostlogd\fR(8) daemon process (Postfix 3.7 and later;
earlier implementations of this command must not have
set\-groupid or set\-userid permissions).
.SH "ENVIRONMENT"
.na
.nf
.ad
.fi
.IP MAIL_CONFIG
Directory with the \fBmain.cf\fR file.
.SH "CONFIGURATION PARAMETERS"
.na
.nf
.ad
.fi
The following \fBmain.cf\fR parameters are especially relevant to
this program.

The text below provides only a parameter summary. See
\fBpostconf\fR(5) for more details including examples.
.IP "\fBconfig_directory (see 'postconf -d' output)\fR"
The default location of the Postfix main.cf and master.cf
configuration files.
.IP "\fBimport_environment (see 'postconf -d' output)\fR"
The list of environment variables that a privileged Postfix
process will import from a non\-Postfix parent process, or name=value
environment overrides.
.IP "\fBsyslog_facility (mail)\fR"
The syslog facility of Postfix logging.
.IP "\fBsyslog_name (see 'postconf -d' output)\fR"
A prefix that is prepended to the process name in syslog
records, so that, for example, "smtpd" becomes "prefix/smtpd".
.PP
Available in Postfix 3.4 and later:
.IP "\fBmaillog_file (empty)\fR"
The name of an optional logfile that is written by the Postfix
\fBpostlogd\fR(8) service.
.IP "\fBpostlog_service_name (postlog)\fR"
The name of the \fBpostlogd\fR(8) service entry in master.cf.
.PP
Available in Postfix 3.9 and later:
.IP "\fBmaillog_file_permissions (0600)\fR"
The file access permissions that will be set when the file
$maillog_file is created for the first time, or when the file is
created after an existing file is rotated.
.SH "SEE ALSO"
.na
.nf
postconf(5), configuration parameters
postlogd(8), Postfix logging
syslogd(8), system logging
.SH "LICENSE"
.na
.nf
.ad
.fi
The Secure Mailer license must be distributed with this software.
.SH HISTORY
.ad
.fi
The \fBpostlog\fR(1) command was introduced with Postfix
version 3.4.
.SH "AUTHOR(S)"
.na
.nf
Wietse Venema
IBM T.J. Watson Research
P.O. Box 704
Yorktown Heights, NY 10598, USA

Wietse Venema
Google, Inc.
111 8th Avenue
New York, NY 10011, USA