xref: /netbsd-src/external/ibm-public/postfix/dist/html/postlog.1.html (revision 059c16a85b0b39d60ad6d18f53c09510815afa2b)
1<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
2        "http://www.w3.org/TR/html4/loose.dtd">
3<html> <head>
4<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5<link rel='stylesheet' type='text/css' href='postfix-doc.css'>
6<title> Postfix manual - postlog(1) </title>
7</head> <body> <pre>
8POSTLOG(1)                                                          POSTLOG(1)
9
10<b>NAME</b>
11       postlog - Postfix-compatible logging utility
12
13<b>SYNOPSIS</b>
14       <b>postlog</b> [<b>-iv</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<b>-p</b> <i>priority</i>] [<b>-t</b> <i>tag</i>] [<i>text...</i>]
15
16<b>DESCRIPTION</b>
17       The  <a href="postlog.1.html"><b>postlog</b>(1)</a>  command implements a Postfix-compatible logging inter-
18       face for use in, for example, shell scripts.
19
20       By default, <a href="postlog.1.html"><b>postlog</b>(1)</a> logs the <i>text</i> given on the command line  as  one
21       record.  If  no <i>text</i> is specified on the command line, <a href="postlog.1.html"><b>postlog</b>(1)</a> reads
22       from standard input and logs each input line as one record.
23
24       By default, logging is sent to  <b>syslogd</b>(8)  or  <a href="postlogd.8.html"><b>postlogd</b>(8)</a>;  when  the
25       standard error stream is connected to a terminal, logging is sent there
26       as well.
27
28       The following options are implemented:
29
30       <b>-c</b> <i>config</i><b>_</b><i>dir</i>
31              Read the <a href="postconf.5.html"><b>main.cf</b></a>  configuration  file  in  the  named  directory
32              instead of the default configuration directory.
33
34       <b>-i</b> (obsolete)
35              Include  the process ID in the logging tag. This flag is ignored
36              as of Postfix 3.4, where the PID is always included.
37
38       <b>-p</b> <i>priority</i> (default: <b>info</b>)
39              Specifies the logging severity: <b>info</b>,  <b>warn</b>,  <b>error</b>,  <b>fatal</b>,  or
40              <b>panic</b>.  With Postfix 3.1 and later, the program will pause for 1
41              second after reporting a <b>fatal</b> or  <b>panic</b>  condition,  just  like
42              other Postfix programs.
43
44       <b>-t</b> <i>tag</i> Specifies  the  logging  tag, that is, the identifying name that
45              appears at the beginning of each logging record. A  default  tag
46              is used when none is specified.
47
48       <b>-v</b>     Enable  verbose  logging  for  debugging  purposes.  Multiple <b>-v</b>
49              options make the software increasingly verbose.
50
51<b>SECURITY</b>
52       The <a href="postlog.1.html"><b>postlog</b>(1)</a> command is designed to run with set-groupid  privileges,
53       so  that  it can connect to the <a href="postlogd.8.html"><b>postlogd</b>(8)</a> daemon process (Postfix 3.7
54       and later; earlier  implementations  of  this  command  must  not  have
55       set-groupid or set-userid permissions).
56
57<b>ENVIRONMENT</b>
58       MAIL_CONFIG
59              Directory with the <a href="postconf.5.html"><b>main.cf</b></a> file.
60
61<b>CONFIGURATION PARAMETERS</b>
62       The  following  <a href="postconf.5.html"><b>main.cf</b></a> parameters are especially relevant to this pro-
63       gram.
64
65       The text below provides only a parameter summary. See  <a href="postconf.5.html"><b>postconf</b>(5)</a>  for
66       more details including examples.
67
68       <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
69              The  default  location of the Postfix <a href="postconf.5.html">main.cf</a> and <a href="master.5.html">master.cf</a> con-
70              figuration files.
71
72       <b><a href="postconf.5.html#import_environment">import_environment</a> (see 'postconf -d' output)</b>
73              The list of environment  variables  that  a  privileged  Postfix
74              process  will  import  from  a  non-Postfix  parent  process, or
75              name=value environment overrides.
76
77       <b><a href="postconf.5.html#syslog_facility">syslog_facility</a> (mail)</b>
78              The syslog facility of Postfix logging.
79
80       <b><a href="postconf.5.html#syslog_name">syslog_name</a> (see 'postconf -d' output)</b>
81              A prefix that  is  prepended  to  the  process  name  in  syslog
82              records, so that, for example, "smtpd" becomes "prefix/smtpd".
83
84       Available in Postfix 3.4 and later:
85
86       <b><a href="postconf.5.html#maillog_file">maillog_file</a> (empty)</b>
87              The  name  of an optional logfile that is written by the Postfix
88              <a href="postlogd.8.html"><b>postlogd</b>(8)</a> service.
89
90       <b><a href="postconf.5.html#postlog_service_name">postlog_service_name</a> (postlog)</b>
91              The name of the <a href="postlogd.8.html"><b>postlogd</b>(8)</a> service entry in <a href="master.5.html">master.cf</a>.
92
93<b>SEE ALSO</b>
94       <a href="postconf.5.html">postconf(5)</a>, configuration parameters
95       <a href="postlogd.8.html">postlogd(8)</a>, Postfix logging
96       syslogd(8), system logging
97
98<b>LICENSE</b>
99       The Secure Mailer license must be distributed with this software.
100
101<b>HISTORY</b>
102       The <a href="postlog.1.html"><b>postlog</b>(1)</a> command was introduced with Postfix version 3.4.
103
104<b>AUTHOR(S)</b>
105       Wietse Venema
106       IBM T.J. Watson Research
107       P.O. Box 704
108       Yorktown Heights, NY 10598, USA
109
110       Wietse Venema
111       Google, Inc.
112       111 8th Avenue
113       New York, NY 10011, USA
114
115                                                                    POSTLOG(1)
116</pre> </body> </html>
117