13
13
<b>postfix</b> [<b>-Dv</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] <i>command</i>
16
This command is reserved for the superuser. To submit
17
mail, use the Postfix <a href="sendmail.1.html"><b>sendmail</b>(1)</a> command.
19
The <a href="postfix.1.html"><b>postfix</b>(1)</a> command controls the operation of the Post-
20
fix mail system: start or stop the <a href="master.8.html"><b>master</b>(8)</a> daemon, do a
21
health check, and other maintenance.
23
By default, the <a href="postfix.1.html"><b>postfix</b>(1)</a> command sets up a standardized
24
environment and runs the <b>postfix-script</b> shell script to do
27
However, when support for multiple Postfix instances is
28
configured, <a href="postfix.1.html"><b>postfix</b>(1)</a> executes the command specified with
29
the <b><a href="postconf.5.html#multi_instance_wrapper">multi_instance_wrapper</a></b> configuration parameter. This
30
command will execute the <i>command</i> for each applicable Post-
16
This command is reserved for the superuser. To submit mail, use the
17
Postfix <a href="sendmail.1.html"><b>sendmail</b>(1)</a> command.
19
The <a href="postfix.1.html"><b>postfix</b>(1)</a> command controls the operation of the Postfix mail sys-
20
tem: start or stop the <a href="master.8.html"><b>master</b>(8)</a> daemon, do a health check, and other
23
By default, the <a href="postfix.1.html"><b>postfix</b>(1)</a> command sets up a standardized environment
24
and runs the <b>postfix-script</b> shell script to do the actual work.
26
However, when support for multiple Postfix instances is configured,
27
<a href="postfix.1.html"><b>postfix</b>(1)</a> executes the command specified with the <b><a href="postconf.5.html#multi_instance_wrapper">multi_instance_wrap</a>-</b>
28
<b><a href="postconf.5.html#multi_instance_wrapper">per</a></b> configuration parameter. This command will execute the <i>command</i> for
29
each applicable Postfix instance.
33
31
The following commands are implemented:
35
<b>check</b> Warn about bad directory/file ownership or permis-
36
sions, and create missing directories.
38
<b>start</b> Start the Postfix mail system. This also runs the
39
configuration check described above.
41
<b>stop</b> Stop the Postfix mail system in an orderly fashion.
42
If possible, running processes are allowed to ter-
43
minate at their earliest convenience.
45
Note: in order to refresh the Postfix mail system
46
after a configuration change, do not use the <b>start</b>
47
and <b>stop</b> commands in succession. Use the <b>reload</b>
50
<b>abort</b> Stop the Postfix mail system abruptly. Running pro-
51
cesses are signaled to stop immediately.
53
<b>flush</b> Force delivery: attempt to deliver every message in
54
the deferred mail queue. Normally, attempts to
55
deliver delayed mail happen at regular intervals,
56
the interval doubling after each failed attempt.
58
Warning: flushing undeliverable mail frequently
59
will result in poor delivery performance of all
62
<b>reload</b> Re-read configuration files. Running processes ter-
63
minate at their earliest convenience.
65
<b>status</b> Indicate if the Postfix mail system is currently
33
<b>check</b> Warn about bad directory/file ownership or permissions, and cre-
34
ate missing directories.
36
<b>start</b> Start the Postfix mail system. This also runs the configuration
37
check described above.
39
<b>stop</b> Stop the Postfix mail system in an orderly fashion. If possible,
40
running processes are allowed to terminate at their earliest
43
Note: in order to refresh the Postfix mail system after a con-
44
figuration change, do not use the <b>start</b> and <b>stop</b> commands in
45
succession. Use the <b>reload</b> command instead.
47
<b>abort</b> Stop the Postfix mail system abruptly. Running processes are
48
signaled to stop immediately.
50
<b>flush</b> Force delivery: attempt to deliver every message in the deferred
51
mail queue. Normally, attempts to deliver delayed mail happen at
52
regular intervals, the interval doubling after each failed
55
Warning: flushing undeliverable mail frequently will result in
56
poor delivery performance of all other mail.
58
<b>reload</b> Re-read configuration files. Running processes terminate at
59
their earliest convenience.
61
<b>status</b> Indicate if the Postfix mail system is currently running.
68
63
<b>set-permissions [</b><i>name</i>=<i>value ...</i><b>]</b>
69
Set the ownership and permissions of Postfix
70
related files and directories, as specified in the
71
<b>postfix-files</b> file.
73
Specify <i>name</i>=<i>value</i> to override and update specific
74
<a href="postconf.5.html">main.cf</a> configuration parameters. Use this, for
75
example, to change the <b><a href="postconf.5.html#mail_owner">mail_owner</a></b> or <b><a href="postconf.5.html#setgid_group">setgid_group</a></b>
76
setting for an already installed Postfix system.
78
This feature is available in Postfix 2.1 and later.
79
With Postfix 2.0 and earlier, use "<b>$<a href="postconf.5.html#config_directory">config_direc</a>-</b>
80
<b><a href="postconf.5.html#config_directory">tory</a>/post-install set-permissions</b>".
64
Set the ownership and permissions of Postfix related files and
65
directories, as specified in the <b>postfix-files</b> file.
67
Specify <i>name</i>=<i>value</i> to override and update specific <a href="postconf.5.html">main.cf</a> con-
68
figuration parameters. Use this, for example, to change the
69
<b><a href="postconf.5.html#mail_owner">mail_owner</a></b> or <b><a href="postconf.5.html#setgid_group">setgid_group</a></b> setting for an already installed
72
This feature is available in Postfix 2.1 and later. With Post-
73
fix 2.0 and earlier, use "<b>$<a href="postconf.5.html#config_directory">config_directory</a>/post-install set-</b>
82
76
<b>upgrade-configuration [</b><i>name</i>=<i>value ...</i><b>]</b>
83
Update the <a href="postconf.5.html"><b>main.cf</b></a> and <a href="master.5.html"><b>master.cf</b></a> files with infor-
84
mation that Postfix needs in order to run: add or
85
update services, and add or update configuration
88
Specify <i>name</i>=<i>value</i> to override and update specific
89
<a href="postconf.5.html">main.cf</a> configuration parameters.
91
This feature is available in Postfix 2.1 and later.
92
With Postfix 2.0 and earlier, use "<b>$<a href="postconf.5.html#config_directory">config_direc</a>-</b>
93
<b><a href="postconf.5.html#config_directory">tory</a>/post-install upgrade-configuration</b>".
77
Update the <a href="postconf.5.html"><b>main.cf</b></a> and <a href="master.5.html"><b>master.cf</b></a> files with information that
78
Postfix needs in order to run: add or update services, and add
79
or update configuration parameter settings.
81
Specify <i>name</i>=<i>value</i> to override and update specific <a href="postconf.5.html">main.cf</a> con-
82
figuration parameters.
84
This feature is available in Postfix 2.1 and later. With Post-
85
fix 2.0 and earlier, use "<b>$<a href="postconf.5.html#config_directory">config_directory</a>/post-install</b>
86
<b>upgrade-configuration</b>".
95
88
The following options are implemented:
97
90
<b>-c</b> <i>config</i><b>_</b><i>dir</i>
98
Read the <a href="postconf.5.html"><b>main.cf</b></a> and <a href="master.5.html"><b>master.cf</b></a> configuration files
99
in the named directory instead of the default con-
100
figuration directory. Use this to distinguish
101
between multiple Postfix instances on the same
91
Read the <a href="postconf.5.html"><b>main.cf</b></a> and <a href="master.5.html"><b>master.cf</b></a> configuration files in the named
92
directory instead of the default configuration directory. Use
93
this to distinguish between multiple Postfix instances on the
104
With Postfix 2.6 and later, this option forces the
105
<a href="postfix.1.html">postfix(1)</a> command to operate on the specified
106
Postfix instance only. This behavior is inherited
107
by <a href="postfix.1.html">postfix(1)</a> commands that run as a descendant of
96
With Postfix 2.6 and later, this option forces the <a href="postfix.1.html">postfix(1)</a>
97
command to operate on the specified Postfix instance only. This
98
behavior is inherited by <a href="postfix.1.html">postfix(1)</a> commands that run as a
99
descendant of the current process.
110
101
<b>-D</b> (with <b>postfix start</b> only)
111
Run each Postfix daemon under control of a debugger
112
as specified via the <b><a href="postconf.5.html#debugger_command">debugger_command</a></b> configuration
102
Run each Postfix daemon under control of a debugger as specified
103
via the <b><a href="postconf.5.html#debugger_command">debugger_command</a></b> configuration parameter.
115
<b>-v</b> Enable verbose logging for debugging purposes. Mul-
116
tiple <b>-v</b> options make the software increasingly
105
<b>-v</b> Enable verbose logging for debugging purposes. Multiple <b>-v</b>
106
options make the software increasingly verbose.
119
108
<b>ENVIRONMENT</b>
120
The <a href="postfix.1.html"><b>postfix</b>(1)</a> command exports the following environment
121
variables before executing the <b>postfix-script</b> file:
109
The <a href="postfix.1.html"><b>postfix</b>(1)</a> command exports the following environment variables
110
before executing the <b>postfix-script</b> file:
123
112
<b>MAIL_CONFIG</b>
124
This is set when the -c command-line option is
113
This is set when the -c command-line option is present.
127
With Postfix 2.6 and later, this environment vari-
128
able forces the <a href="postfix.1.html">postfix(1)</a> command to operate on
129
the specified Postfix instance only. This behavior
130
is inherited by <a href="postfix.1.html">postfix(1)</a> commands that run as a
131
descendant of the current process.
115
With Postfix 2.6 and later, this environment variable forces the
116
<a href="postfix.1.html">postfix(1)</a> command to operate on the specified Postfix instance
117
only. This behavior is inherited by <a href="postfix.1.html">postfix(1)</a> commands that
118
run as a descendant of the current process.
133
120
<b>MAIL_VERBOSE</b>
134
This is set when the -v command-line option is
121
This is set when the -v command-line option is present.
137
123
<b>MAIL_DEBUG</b>
138
This is set when the -D command-line option is
124
This is set when the -D command-line option is present.
141
126
<b>CONFIGURATION PARAMETERS</b>
142
The following <a href="postconf.5.html"><b>main.cf</b></a> configuration parameters are
143
exported as environment variables with the same names:
127
The following <a href="postconf.5.html"><b>main.cf</b></a> configuration parameters are exported as environ-
128
ment variables with the same names:
145
130
<b><a href="postconf.5.html#command_directory">command_directory</a> (see 'postconf -d' output)</b>
146
The location of all postfix administrative com-
131
The location of all postfix administrative commands.
149
133
<b><a href="postconf.5.html#daemon_directory">daemon_directory</a> (see 'postconf -d' output)</b>
150
The directory with Postfix support programs and
134
The directory with Postfix support programs and daemon programs.
153
136
<b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
154
The default location of the Postfix <a href="postconf.5.html">main.cf</a> and
155
<a href="master.5.html">master.cf</a> configuration files.
137
The default location of the Postfix <a href="postconf.5.html">main.cf</a> and <a href="master.5.html">master.cf</a> con-
157
140
<b><a href="postconf.5.html#queue_directory">queue_directory</a> (see 'postconf -d' output)</b>
158
The location of the Postfix top-level queue direc-
141
The location of the Postfix top-level queue directory.
161
143
<b><a href="postconf.5.html#mail_owner">mail_owner</a> (postfix)</b>
162
The UNIX system account that owns the Postfix queue
163
and most Postfix daemon processes.
144
The UNIX system account that owns the Postfix queue and most
145
Postfix daemon processes.
165
147
<b><a href="postconf.5.html#setgid_group">setgid_group</a> (postdrop)</b>
166
The group ownership of set-gid Postfix commands and
167
of group-writable Postfix directories.
148
The group ownership of set-gid Postfix commands and of group-
149
writable Postfix directories.
169
151
<b><a href="postconf.5.html#sendmail_path">sendmail_path</a> (see 'postconf -d' output)</b>
170
A Sendmail compatibility feature that specifies the
171
location of the Postfix <a href="sendmail.1.html"><b>sendmail</b>(1)</a> command.
152
A Sendmail compatibility feature that specifies the location of
153
the Postfix <a href="sendmail.1.html"><b>sendmail</b>(1)</a> command.
173
155
<b><a href="postconf.5.html#newaliases_path">newaliases_path</a> (see 'postconf -d' output)</b>
174
Sendmail compatibility feature that specifies the
175
location of the <a href="newaliases.1.html"><b>newaliases</b>(1)</a> command.
156
Sendmail compatibility feature that specifies the location of
157
the <a href="newaliases.1.html"><b>newaliases</b>(1)</a> command.
177
159
<b><a href="postconf.5.html#mailq_path">mailq_path</a> (see 'postconf -d' output)</b>
178
Sendmail compatibility feature that specifies where
179
the Postfix <a href="mailq.1.html"><b>mailq</b>(1)</a> command is installed.
160
Sendmail compatibility feature that specifies where the Postfix
161
<a href="mailq.1.html"><b>mailq</b>(1)</a> command is installed.
181
163
<b><a href="postconf.5.html#html_directory">html_directory</a> (see 'postconf -d' output)</b>
182
The location of Postfix HTML files that describe
183
how to build, configure or operate a specific Post-
184
fix subsystem or feature.
164
The location of Postfix HTML files that describe how to build,
165
configure or operate a specific Postfix subsystem or feature.
186
167
<b><a href="postconf.5.html#manpage_directory">manpage_directory</a> (see 'postconf -d' output)</b>
187
168
Where the Postfix manual pages are installed.
189
170
<b><a href="postconf.5.html#readme_directory">readme_directory</a> (see 'postconf -d' output)</b>
190
The location of Postfix README files that describe
191
how to build, configure or operate a specific Post-
192
fix subsystem or feature.
171
The location of Postfix README files that describe how to build,
172
configure or operate a specific Postfix subsystem or feature.
194
174
Available in Postfix version 2.5 and later:
196
176
<b><a href="postconf.5.html#data_directory">data_directory</a> (see 'postconf -d' output)</b>
197
The directory with Postfix-writable data files (for
198
example: caches, pseudo-random numbers).
177
The directory with Postfix-writable data files (for example:
178
caches, pseudo-random numbers).
200
180
Other configuration parameters:
202
182
<b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
203
The default location of the Postfix <a href="postconf.5.html">main.cf</a> and
204
<a href="master.5.html">master.cf</a> configuration files.
183
The default location of the Postfix <a href="postconf.5.html">main.cf</a> and <a href="master.5.html">master.cf</a> con-
206
186
<b><a href="postconf.5.html#import_environment">import_environment</a> (see 'postconf -d' output)</b>
207
The list of environment parameters that a Postfix
208
process will import from a non-Postfix parent
187
The list of environment parameters that a Postfix process will
188
import from a non-Postfix parent process.
211
190
<b><a href="postconf.5.html#syslog_facility">syslog_facility</a> (mail)</b>
212
191
The syslog facility of Postfix logging.
214
193
<b><a href="postconf.5.html#syslog_name">syslog_name</a> (see 'postconf -d' output)</b>
215
The mail system name that is prepended to the
216
process name in syslog records, so that "smtpd"
217
becomes, for example, "postfix/smtpd".
194
The mail system name that is prepended to the process name in
195
syslog records, so that "smtpd" becomes, for example, "post-
219
198
Available in Postfix version 2.6 and later:
221
200
<b><a href="postconf.5.html#multi_instance_directories">multi_instance_directories</a> (empty)</b>
222
An optional list of non-default Postfix configura-
223
tion directories; these directories belong to addi-
224
tional Postfix instances that share the Postfix
225
executable files and documentation with the default
226
Postfix instance, and that are started, stopped,
201
An optional list of non-default Postfix configuration directo-
202
ries; these directories belong to additional Postfix instances
203
that share the Postfix executable files and documentation with
204
the default Postfix instance, and that are started, stopped,
227
205
etc., together with the default Postfix instance.
229
207
<b><a href="postconf.5.html#multi_instance_wrapper">multi_instance_wrapper</a> (empty)</b>
230
The pathname of a multi-instance manager command
231
that the <a href="postfix.1.html"><b>postfix</b>(1)</a> command invokes when the
232
<a href="postconf.5.html#multi_instance_directories">multi_instance_directories</a> parameter value is non-
208
The pathname of a multi-instance manager command that the <a href="postfix.1.html"><b>post-</b></a>
209
<a href="postfix.1.html"><b>fix</b>(1)</a> command invokes when the <a href="postconf.5.html#multi_instance_directories">multi_instance_directories</a>
210
parameter value is non-empty.
235
212
<b><a href="postconf.5.html#multi_instance_group">multi_instance_group</a> (empty)</b>
236
The optional instance group name of this Postfix
213
The optional instance group name of this Postfix instance.
239
215
<b><a href="postconf.5.html#multi_instance_name">multi_instance_name</a> (empty)</b>
240
The optional instance name of this Postfix
216
The optional instance name of this Postfix instance.
243
218
<b><a href="postconf.5.html#multi_instance_enable">multi_instance_enable</a> (no)</b>
244
Allow this Postfix instance to be started, stopped,
245
etc., by a multi-instance manager.
219
Allow this Postfix instance to be started, stopped, etc., by a
220
multi-instance manager.
248
Prior to Postfix version 2.6, all of the following files
249
were in <b>$<a href="postconf.5.html#config_directory">config_directory</a></b>. Some files are now in <b>$<a href="postconf.5.html#daemon_directory">dae</a>-</b>
250
<b><a href="postconf.5.html#daemon_directory">mon_directory</a></b> so that they can be shared among multiple
251
instances that run the same Postfix version.
223
Prior to Postfix version 2.6, all of the following files were in <b>$<a href="postconf.5.html#config_directory">con</a>-</b>
224
<b><a href="postconf.5.html#config_directory">fig_directory</a></b>. Some files are now in <b>$<a href="postconf.5.html#daemon_directory">daemon_directory</a></b> so that they can
225
be shared among multiple instances that run the same Postfix version.
253
Use the command "<b>postconf <a href="postconf.5.html#config_directory">config_directory</a></b>" or "<b>postconf</b>
254
<b><a href="postconf.5.html#daemon_directory">daemon_directory</a></b>" to expand the names into their actual
227
Use the command "<b>postconf <a href="postconf.5.html#config_directory">config_directory</a></b>" or "<b>postconf <a href="postconf.5.html#daemon_directory">daemon_direc</a>-</b>
228
<b><a href="postconf.5.html#daemon_directory">tory</a></b>" to expand the names into their actual values.
257
230
$<a href="postconf.5.html#config_directory">config_directory</a>/<a href="postconf.5.html">main.cf</a>, Postfix configuration parameters
258
231
$<a href="postconf.5.html#config_directory">config_directory</a>/<a href="master.5.html">master.cf</a>, Postfix daemon processes
added
removed
html/postfix.1.html
