~ubuntu-branches/ubuntu/dapper/postfix/dapper-security

« back to all changes in this revision

Viewing changes to man/man1/postfix.1

  • Committer: Bazaar Package Importer
  • Author(s): LaMont Jones
  • Date: 2005-02-27 09:33:07 UTC
  • Revision ID: james.westby@ubuntu.com-20050227093307-cn789t27ibnlh6tf
Tags: upstream-2.1.5
ImportĀ upstreamĀ versionĀ 2.1.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH POSTFIX 1 
 
2
.ad
 
3
.fi
 
4
.SH NAME
 
5
postfix
 
6
\-
 
7
Postfix control program
 
8
.SH "SYNOPSIS"
 
9
.na
 
10
.nf
 
11
.fi
 
12
\fBpostfix\fR [\fB-Dv\fR] [\fB-c \fIconfig_dir\fR] \fIcommand\fR
 
13
.SH DESCRIPTION
 
14
.ad
 
15
.fi
 
16
This command is reserved for the superuser. To submit mail,
 
17
use the Postfix \fBsendmail\fR command.
 
18
 
 
19
The \fBpostfix\fR command controls the operation of the Postfix
 
20
mail system: start or stop the \fBmaster\fR daemon, do a health
 
21
check, and other maintenance.
 
22
 
 
23
The \fBpostfix\fR command sets up a standardized environment and
 
24
runs the \fBpostfix-script\fR shell script to do the actual work.
 
25
 
 
26
The following commands are implemented:
 
27
.IP \fBcheck\fR
 
28
Validate the Postfix mail system configuration. Warn about bad
 
29
directory/file ownership or permissions, and create missing
 
30
directories.
 
31
.IP \fBstart\fR
 
32
Start the Postfix mail system. This also runs the configuration
 
33
check described above.
 
34
.IP \fBstop\fR
 
35
Stop the Postfix mail system in an orderly fashion. Running processes
 
36
are allowed to terminate at their earliest convenience.
 
37
.sp
 
38
Note: in order to refresh the Postfix mail system after a
 
39
configuration change, do not use the \fBstart\fR and \fBstop\fR
 
40
commands in succession. Use the \fBreload\fR command instead.
 
41
.IP \fBabort\fR
 
42
Stop the Postfix mail system abruptly. Running processes are
 
43
signaled to stop immediately.
 
44
.IP \fBflush\fR
 
45
Force delivery: attempt to deliver every message in the deferred
 
46
mail queue. Normally, attempts to deliver delayed mail happen at
 
47
regular intervals, the interval doubling after each failed attempt.
 
48
.sp
 
49
Warning: flushing undeliverable mail frequently will result in
 
50
poor delivery performance of all other mail.
 
51
.IP \fBreload\fR
 
52
Re-read configuration files. Running processes terminate at their
 
53
earliest convenience.
 
54
.IP "\fBset-permissions\fR \fB[\fIname\fR=\fIvalue ...\fB]\fR
 
55
Set the ownership and permissions of Postfix related files and
 
56
directories, as specified in the \fBpostfix-files\fR file.
 
57
.sp
 
58
Specify \fIname\fR=\fIvalue\fR to override and update specific
 
59
main.cf configuration parameters. Use this, for example, to
 
60
change the \fBmail_owner\fR or \fBsetgid_group\fR setting for an
 
61
already installed Postfix system.
 
62
.sp
 
63
This feature is available in Postfix 2.1 and later.
 
64
.IP "\fBupgrade-configuration\fR \fB[\fIname\fR=\fIvalue ...\fB]\fR
 
65
Update the \fBmain.cf\fR and \fBmaster.cf\fR files with information
 
66
that Postfix needs in order to run: add or update services, and add
 
67
or update configuration parameter settings.
 
68
.sp
 
69
Specify \fIname\fR=\fIvalue\fR to override and update specific
 
70
main.cf configuration parameters.
 
71
.sp
 
72
This feature is available in Postfix 2.1 and later.
 
73
.PP
 
74
The following options are implemented:
 
75
.IP "\fB-c \fIconfig_dir\fR"
 
76
Read the \fBmain.cf\fR and \fBmaster.cf\fR configuration files in
 
77
the named directory instead of the default configuration directory.
 
78
Use this to distinguish between multiple Postfix instances on the
 
79
same host.
 
80
.IP "\fB-D\fR (with \fBpostfix start\fR only)"
 
81
Run each Postfix daemon under control of a debugger as specified
 
82
via the \fBdebugger_command\fR configuration parameter.
 
83
.IP \fB-v\fR
 
84
Enable verbose logging for debugging purposes. Multiple \fB-v\fR
 
85
options make the software increasingly verbose.
 
86
.SH "ENVIRONMENT"
 
87
.na
 
88
.nf
 
89
.ad
 
90
.fi
 
91
The \fBpostfix\fR command exports the following environment
 
92
variables before executing the \fBpostfix-script\fR file:
 
93
.IP \fBMAIL_CONFIG\fR
 
94
This is set when the -c command-line option is present.
 
95
.IP \fBMAIL_VERBOSE\fR
 
96
This is set when the -v command-line option is present.
 
97
.IP \fBMAIL_DEBUG\fR
 
98
This is set when the -D command-line option is present.
 
99
.SH "CONFIGURATION PARAMETERS"
 
100
.na
 
101
.nf
 
102
.ad
 
103
.fi
 
104
The following \fBmain.cf\fR configuration parameters are
 
105
exported as environment variables with the same names:
 
106
.IP "\fBcommand_directory (see 'postconf -d' output)\fR"
 
107
The location of all postfix administrative commands.
 
108
.IP "\fBdaemon_directory (see 'postconf -d' output)\fR"
 
109
The directory with Postfix support programs and daemon programs.
 
110
.IP "\fBconfig_directory (see 'postconf -d' output)\fR"
 
111
The default location of the Postfix main.cf and master.cf
 
112
configuration files.
 
113
.IP "\fBqueue_directory (see 'postconf -d' output)\fR"
 
114
The location of the Postfix top-level queue directory.
 
115
.IP "\fBmail_owner (postfix)\fR"
 
116
The UNIX system account that owns the Postfix queue and most Postfix
 
117
daemon processes.
 
118
.IP "\fBsetgid_group (postdrop)\fR"
 
119
The group ownership of set-gid Postfix commands and of group-writable
 
120
Postfix directories.
 
121
.IP "\fBsendmail_path (see 'postconf -d' output)\fR"
 
122
A Sendmail compatibility feature that specifies the location of
 
123
the Postfix sendmail(1) command.
 
124
.IP "\fBnewaliases_path (see 'postconf -d' output)\fR"
 
125
Sendmail compatibility feature that specifies the location of the
 
126
newaliases(1) command.
 
127
.IP "\fBmailq_path (see 'postconf -d' output)\fR"
 
128
Sendmail compatibility feature that specifies where the Postfix
 
129
mailq(1) command is installed.
 
130
.IP "\fBhtml_directory (see 'postconf -d' output)\fR"
 
131
The location of Postfix HTML files that describe how to build,
 
132
configure or operate a specific Postfix subsystem or feature.
 
133
.IP "\fBmanpage_directory (see 'postconf -d' output)\fR"
 
134
Where the Postfix manual pages are installed.
 
135
.IP "\fBreadme_directory (see 'postconf -d' output)\fR"
 
136
The location of Postfix README files that describe how to build,
 
137
configure or operate a specific Postfix subsystem or feature.
 
138
.PP
 
139
Other configuration parameters:
 
140
.IP "\fBconfig_directory (see 'postconf -d' output)\fR"
 
141
The default location of the Postfix main.cf and master.cf
 
142
configuration files.
 
143
.IP "\fBimport_environment (see 'postconf -d' output)\fR"
 
144
The list of environment parameters that a Postfix process will
 
145
import from a non-Postfix parent process.
 
146
.IP "\fBsyslog_facility (mail)\fR"
 
147
The syslog facility of Postfix logging.
 
148
.IP "\fBsyslog_name (postfix)\fR"
 
149
The mail system name that is prepended to the process name in syslog
 
150
records, so that "smtpd" becomes, for example, "postfix/smtpd".
 
151
.SH "FILES"
 
152
.na
 
153
.nf
 
154
/etc/postfix/main.cf, Postfix configuration parameters
 
155
/etc/postfix/master.cf, Postfix daemon processes
 
156
/etc/postfix/postfix-files, file/directory permissions
 
157
/etc/postfix/postfix-script, administrative commands
 
158
/etc/postfix/post-install, post-installation configuration
 
159
.SH "SEE ALSO"
 
160
.na
 
161
.nf
 
162
Commands:
 
163
postalias(1), create/update/query alias database
 
164
postcat(1), examine Postfix queue file
 
165
postkick(1), trigger Postfix daemon
 
166
postlock(1), Postfix-compatible locking
 
167
postlog(1), Postfix-compatible logging
 
168
postmap(1), Postfix lookup table manager
 
169
postqueue(1), Postfix mail queue control
 
170
postsuper(1), Postfix housekeeping
 
171
sendmail(1), Sendmail compatibility interface
 
172
 
 
173
Postfix configuration:
 
174
postconf(5), Postfix configuration parameters
 
175
 
 
176
Table-driven mechanisms:
 
177
access(5), Postfix SMTP access control table
 
178
aliases(5), Postfix alias database
 
179
header_checks(5), body_checks(5), content inspection
 
180
canonical(5), Postfix address rewriting
 
181
relocated(5), Users that have moved
 
182
transport(5), Postfix routing table
 
183
virtual(5), Postfix virtual aliasing
 
184
 
 
185
Table lookup mechanisms:
 
186
cidr_table(5), Associate CIDR pattern with value
 
187
ldap_table(5), Postfix LDAP client
 
188
mysql_table(5), Postfix MYSQL client
 
189
pcre_table(5), Associate PCRE pattern with value
 
190
pgsql_table(5), Postfix PostgreSQL client
 
191
regexp_table(5), Associate POSIX regexp pattern with value
 
192
tcp_table(5), Postfix client-server table lookup
 
193
 
 
194
Daemon processes:
 
195
anvil(8), Postfix connection/rate limiting
 
196
bounce(8), defer(8), trace(8), Delivery status reports
 
197
cleanup(8), canonicalize and enqueue message
 
198
error(8), Postfix error delivery agent
 
199
flush(8), Postfix fast ETRN service
 
200
lmtp(8), Postfix LMTP client
 
201
local(8), Postfix local delivery agent
 
202
master(8), Postfix master daemon
 
203
oqmgr(8), old Postfix queue manager
 
204
pickup(8), Postfix local mail pickup
 
205
pipe(8), deliver mail to non-Postfix command
 
206
proxymap(8), Postfix lookup table proxy server
 
207
qmgr(8), Postfix queue manager
 
208
qmqpd(8), Postfix QMQP server
 
209
showq(8), list Postfix mail queue
 
210
smtp(8), Postfix SMTP client
 
211
smtpd(8), Postfix SMTP server
 
212
spawn(8), run non-Postfix server
 
213
trivial-rewrite(8), Postfix address rewriting
 
214
verify(8), Postfix address verification
 
215
virtual(8), Postfix virtual delivery agent
 
216
 
 
217
Other:
 
218
syslogd(8), system logging
 
219
.SH "README FILES"
 
220
.na
 
221
.nf
 
222
.ad
 
223
.fi
 
224
Use "\fBpostconf readme_directory\fR" or
 
225
"\fBpostconf html_directory\fR" to locate this information.
 
226
.na
 
227
.nf
 
228
OVERVIEW, overview of Postfix commands and processes
 
229
BASIC_CONFIGURATION_README, Postfix basic configuration
 
230
ADDRESS_REWRITING_README, Postfix address rewriting
 
231
SMTPD_ACCESS_README, SMTP relay/access control
 
232
CONTENT_INSPECTION_README, Postfix content inspection
 
233
QSHAPE_README, Postfix queue analysis
 
234
.SH "LICENSE"
 
235
.na
 
236
.nf
 
237
.ad
 
238
.fi
 
239
The Secure Mailer license must be distributed with this software.
 
240
.SH "AUTHOR(S)"
 
241
.na
 
242
.nf
 
243
Wietse Venema
 
244
IBM T.J. Watson Research
 
245
P.O. Box 704
 
246
Yorktown Heights, NY 10598, USA