~ubuntu-branches/debian/sid/postfix/sid

« back to all changes in this revision

Viewing changes to html/postconf.1.html

  • Committer: Package Import Robot
  • Author(s): LaMont Jones
  • Date: 2012-03-20 13:47:16 UTC
  • mfrom: (1.1.34) (39.1.16 trunk)
  • Revision ID: package-import@ubuntu.com-20120320134716-o62kosz3odzt1rh6
Tags: 2.9.1-2
Drop unnecessary openssl check, since sonames will save us.

Show diffs side-by-side

added added

removed removed

Lines of Context:
10
10
       postconf - Postfix configuration utility
11
11
 
12
12
<b>SYNOPSIS</b>
13
 
       <b>postconf</b> [<b>-dhnv</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<i>parameter ...</i>]
 
13
       <b>Managing <a href="postconf.5.html">main.cf</a>:</b>
14
14
 
15
 
       <b>postconf</b> [<b>-aAmlv</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>]
 
15
       <b>postconf</b> [<b>-dfhnv</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<b>-C</b> <i>class,...</i>] [<i>parame-</i>
 
16
       <i>ter ...</i>]
16
17
 
17
18
       <b>postconf</b> [<b>-ev</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<i>parameter=value ...</i>]
18
19
 
19
20
       <b>postconf</b> [<b>-#v</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<i>parameter ...</i>]
20
21
 
 
22
       <b>Managing <a href="master.5.html">master.cf</a>:</b>
 
23
 
 
24
       <b>postconf</b> [<b>-fMv</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<i>service ...</i>]
 
25
 
 
26
       <b>Managing bounce message templates:</b>
 
27
 
21
28
       <b>postconf</b> [<b>-btv</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<i>template</i><b>_</b><i>file</i>]
22
29
 
 
30
       <b>Managing other configuration:</b>
 
31
 
 
32
       <b>postconf</b> [<b>-aAlmv</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>]
 
33
 
23
34
<b>DESCRIPTION</b>
24
 
       The <a href="postconf.1.html"><b>postconf</b>(1)</a> command displays the actual values of con-
25
 
       figuration  parameters,  changes  configuration  parameter
26
 
       values,  or displays other configuration information about
27
 
       the Postfix mail system.
 
35
       By default, the <a href="postconf.1.html"><b>postconf</b>(1)</a> command displays the values of
 
36
       <a href="postconf.5.html"><b>main.cf</b></a> configuration parameters, and warns about possible
 
37
       mis-typed parameter names (Postfix 2.9 and later).  It can
 
38
       also  change  <a href="postconf.5.html"><b>main.cf</b></a>  configuration  parameter values, or
 
39
       display other configuration information about the  Postfix
 
40
       mail system.
28
41
 
29
42
       Options:
30
43
 
31
 
       <b>-a</b>     List the available SASL server plug-in types.   The
32
 
              SASL    plug-in   type   is   selected   with   the
 
44
       <b>-a</b>     List  the available SASL server plug-in types.  The
 
45
              SASL   plug-in   type   is   selected   with    the
33
46
              <b><a href="postconf.5.html#smtpd_sasl_type">smtpd_sasl_type</a></b> configuration parameter by specify-
34
47
              ing one of the names listed below.
35
48
 
36
 
              <b>cyrus</b>  This  server plug-in is available when Post-
 
49
              <b>cyrus</b>  This server plug-in is available when  Post-
37
50
                     fix is built with Cyrus SASL support.
38
51
 
39
52
              <b>dovecot</b>
40
53
                     This server plug-in uses the Dovecot authen-
41
54
                     tication server, and is available when Post-
42
 
                     fix is built with any form of SASL support.
 
55
                     fix  is built with any form of SASL support.
43
56
 
44
57
              This feature is  available  with  Postfix  2.3  and
45
58
              later.
59
72
       <b>-b</b> [<i>template</i><b>_</b><i>file</i>]
60
73
              Display the message text that appears at the begin-
61
74
              ning of delivery  status  notification  (DSN)  mes-
62
 
              sages,  with  $<b>name</b>  expressions replaced by actual
63
 
              values.  To override  the  built-in  message  text,
64
 
              specify  a  template file at the end of the command
65
 
              line, or specify a template file  in  <a href="postconf.5.html">main.cf</a>  with
66
 
              the   <b><a href="postconf.5.html#bounce_template_file">bounce_template_file</a></b>   parameter.   To  force
67
 
              selection of the built-in message  text  templates,
68
 
              specify  an empty template file name (in shell lan-
69
 
              guage: "").
70
 
 
71
 
              This feature is  available  with  Postfix  2.3  and
 
75
              sages, replacing $<b>name</b> expressions with actual val-
 
76
              ues as described in <a href="bounce.5.html"><b>bounce</b>(5)</a>.
 
77
 
 
78
              To override the built-in templates, specify a  tem-
 
79
              plate  file name at the end of the <a href="postconf.1.html"><b>postconf</b>(1)</a> com-
 
80
              mand line, or specify a file name in  <a href="postconf.5.html"><b>main.cf</b></a>  with
 
81
              the <b><a href="postconf.5.html#bounce_template_file">bounce_template_file</a></b> parameter.
 
82
 
 
83
              To force selection of the built-in templates, spec-
 
84
              ify an empty template file name on the  <a href="postconf.1.html"><b>postconf</b>(1)</a>
 
85
              command line (in shell language: "").
 
86
 
 
87
              This  feature  is  available  with  Postfix 2.3 and
72
88
              later.
73
89
 
74
90
       <b>-c</b> <i>config</i><b>_</b><i>dir</i>
75
 
              The  <a href="postconf.5.html"><b>main.cf</b></a>  configuration  file  is  in the named
 
91
              The <a href="postconf.5.html"><b>main.cf</b></a> configuration  file  is  in  the  named
76
92
              directory  instead  of  the  default  configuration
77
93
              directory.
78
94
 
79
 
       <b>-d</b>     Print  default parameter settings instead of actual
80
 
              settings.
81
 
 
82
 
       <b>-e</b>     Edit the <a href="postconf.5.html"><b>main.cf</b></a> configuration file.  The  file  is
83
 
              copied to a temporary file then renamed into place.
84
 
              Parameters and values are specified on the  command
85
 
              line.   Use   quotes  in  order  to  protect  shell
86
 
              metacharacters and whitespace.
87
 
 
88
 
              With Postfix version 2.8 and later, the  <b>-e</b>  is  no
89
 
              longer needed.
90
 
 
91
 
       <b>-h</b>     Show parameter values only, not the "<i>name =</i> " label
92
 
              that normally precedes the value.
93
 
 
94
 
       <b>-l</b>     List the names of  all  supported  mailbox  locking
 
95
       <b>-C</b> <i>class,...</i>
 
96
              When displaying  <a href="postconf.5.html"><b>main.cf</b></a>  parameters,  select  only
 
97
              parameters from the specified class(es):
 
98
 
 
99
              <b>builtin</b>
 
100
                     Parameters with built-in names.
 
101
 
 
102
              <b>service</b>
 
103
                     Parameters  with  service-defined names (the
 
104
                     first field of  a  <a href="master.5.html"><b>master.cf</b></a>  entry  plus  a
 
105
                     Postfix-defined suffix).
 
106
 
 
107
              <b>user</b>   Parameters with user-defined names.
 
108
 
 
109
              <b>all</b>    All the above classes.
 
110
 
 
111
              The default is as if "<b>-C all</b>" is specified.
 
112
 
 
113
       <b>-d</b>     Print <a href="postconf.5.html"><b>main.cf</b></a> default parameter settings instead of
 
114
              actual settings.  Specify <b>-df</b> to  fold  long  lines
 
115
              for human readability (Postfix 2.9 and later).
 
116
 
 
117
       <b>-e</b>     Edit  the  <a href="postconf.5.html"><b>main.cf</b></a>  configuration  file, and update
 
118
              parameter settings with the "<i>name</i>=<i>value</i>"  pairs  on
 
119
              the <a href="postconf.1.html"><b>postconf</b>(1)</a> command line. The file is copied to
 
120
              a temporary file then renamed into place.   Specify
 
121
              quotes to protect special characters and whitespace
 
122
              on the <a href="postconf.1.html"><b>postconf</b>(1)</a> command line.
 
123
 
 
124
              The <b>-e</b> is no longer needed with Postfix version 2.8
 
125
              and later.
 
126
 
 
127
       <b>-f</b>     Fold  long lines when printing <a href="postconf.5.html"><b>main.cf</b></a> or <a href="master.5.html"><b>master.cf</b></a>
 
128
              configuration file entries, for human  readability.
 
129
 
 
130
              This  feature  is  available  with  Postfix 2.9 and
 
131
              later.
 
132
 
 
133
       <b>-h</b>     Show <a href="postconf.5.html"><b>main.cf</b></a> parameter values without the "<i>name</i> = "
 
134
              label that normally precedes the value.
 
135
 
 
136
       <b>-l</b>     List  the  names  of  all supported mailbox locking
95
137
              methods.  Postfix supports the following methods:
96
138
 
97
 
              <b>flock</b>  A  kernel-based  advisory locking method for
98
 
                     local files only.  This  locking  method  is
99
 
                     available  on  systems with a BSD compatible
 
139
              <b>flock</b>  A kernel-based advisory locking  method  for
 
140
                     local  files  only.   This locking method is
 
141
                     available on systems with a  BSD  compatible
100
142
                     library.
101
143
 
102
 
              <b>fcntl</b>  A kernel-based advisory locking  method  for
 
144
              <b>fcntl</b>  A  kernel-based  advisory locking method for
103
145
                     local and remote files.
104
146
 
105
147
              <b>dotlock</b>
106
 
                     An   application-level  locking  method.  An
107
 
                     application locks a file named  <i>filename</i>  by
108
 
                     creating  a  file  named <i>filename</i><b>.lock</b>.  The
109
 
                     application is expected to  remove  its  own
110
 
                     lock  file, as well as stale lock files that
 
148
                     An  application-level  locking  method.   An
 
149
                     application  locks  a file named <i>filename</i> by
 
150
                     creating a file  named  <i>filename</i><b>.lock</b>.   The
 
151
                     application  is  expected  to remove its own
 
152
                     lock file, as well as stale lock files  that
111
153
                     were left behind after abnormal termination.
112
154
 
113
155
       <b>-m</b>     List the names of all supported lookup table types.
139
181
                     implemented  for  testing,  someone may find
140
182
                     this useful someday.
141
183
 
 
184
              <b>fail</b>   A table that reliably  fails  all  requests.
 
185
                     The  lookup  table name is used for logging.
 
186
                     This table exists to simplify Postfix  error
 
187
                     tests.
 
188
 
142
189
              <b>hash</b>   An indexed file type based on hashing.  This
143
 
                     is  available  on  systems  with support for
 
190
                     is available on  systems  with  support  for
144
191
                     Berkeley DB databases.
145
192
 
146
193
              <b>internal</b>
148
195
                     tent are lost when a process terminates.
149
196
 
150
197
              <b>ldap</b> (read-only)
151
 
                     Perform  lookups  using  the  LDAP protocol.
 
198
                     Perform lookups  using  the  LDAP  protocol.
152
199
                     This is described in <a href="ldap_table.5.html"><b>ldap_table</b>(5)</a>.
153
200
 
 
201
              <b>memcache</b>
 
202
                     Perform lookups using the memcache protocol.
 
203
                     This is described in <a href="memcache_table.5.html"><b>memcache_table</b>(5)</a>.
 
204
 
154
205
              <b>mysql</b> (read-only)
155
206
                     Perform lookups using  the  MYSQL  protocol.
156
207
                     This is described in <a href="mysql_table.5.html"><b>mysql_table</b>(5)</a>.
164
215
                     Perform  lookups using the PostgreSQL proto-
165
216
                     col. This is described in <a href="pgsql_table.5.html"><b>pgsql_table</b>(5)</a>.
166
217
 
167
 
              <b>proxy</b> (read-only)
168
 
                     A lookup table that is implemented  via  the
 
218
              <b>proxy</b>  A lookup table that is implemented  via  the
169
219
                     Postfix  <a href="proxymap.8.html"><b>proxymap</b>(8)</a> service. The table name
170
220
                     syntax is <i>type</i><b>:</b><i>name</i>.
171
221
 
184
234
 
185
235
              <b>static</b> (read-only)
186
236
                     A  table  that  always  returns  its name as
187
 
                     lookup result.  For  example,  <b>static:foobar</b>
 
237
                     lookup result.  For  example,  <b><a href="DATABASE_README.html#types">static</a>:foobar</b>
188
238
                     always  returns  the string <b>foobar</b> as lookup
189
239
                     result.
190
240
 
191
241
              <b>tcp</b> (read-only)
192
242
                     Perform lookups using a simple request-reply
193
 
                     protocol that is described in <a href="tcp_table.5.html"><b>tcp_table</b>(5)</a>.
 
243
                     protocol  that is described in <a href="tcp_table.5.html"><b>tcp_table</b>(5)</a>.
194
244
 
195
245
              <b>texthash</b> (read-only)
196
 
                     Produces  similar  results  as  hash: files,
 
246
                     Produces similar  results  as  hash:  files,
197
247
                     except  that  you  don't  need  to  run  the
198
 
                     <a href="postmap.1.html">postmap(1)</a>  command  before  you can use the
199
 
                     file, and that it does  not  detect  changes
 
248
                     <a href="postmap.1.html"><b>postmap</b>(1)</a> command before you  can  use  the
 
249
                     file,  and  that  it does not detect changes
200
250
                     after the file is read.
201
251
 
202
252
              <b>unix</b> (read-only)
203
 
                     A  limited way to query the UNIX authentica-
 
253
                     A limited way to query the UNIX  authentica-
204
254
                     tion  database.  The  following  tables  are
205
255
                     implemented:
206
256
 
207
257
                     <b>unix:passwd.byname</b>
208
 
                            The  table is the UNIX password data-
209
 
                            base. The key is a login  name.   The
210
 
                            result  is  a  password file entry in
 
258
                            The table is the UNIX password  data-
 
259
                            base.  The  key is a login name.  The
 
260
                            result is a password  file  entry  in
211
261
                            <b>passwd</b>(5) format.
212
262
 
213
263
                     <b>unix:group.byname</b>
214
264
                            The table is the UNIX group database.
215
 
                            The  key is a group name.  The result
216
 
                            is a group  file  entry  in  <b>group</b>(5)
 
265
                            The key is a group name.  The  result
 
266
                            is  a  group  file  entry in <b>group</b>(5)
217
267
                            format.
218
268
 
219
 
              Other  table types may exist depending on how Post-
 
269
              Other table types may exist depending on how  Post-
220
270
              fix was built.
221
271
 
222
 
       <b>-n</b>     Print parameter settings that are not left at their
223
 
              built-in default value, because they are explicitly
224
 
              specified in <a href="postconf.5.html">main.cf</a>.
 
272
       <b>-M</b>     Show  <a href="master.5.html"><b>master.cf</b></a>  file  contents  instead of <a href="postconf.5.html"><b>main.cf</b></a>
 
273
              file contents.  Specify <b>-Mf</b> to fold long lines  for
 
274
              human readability.
 
275
 
 
276
              If <i>service ...</i> is specified, only the matching ser-
 
277
              vices will be output. For  example,  "<b>postconf  -Mf</b>
 
278
              <b>inet</b>"  will  output all services that listen on the
 
279
              network.
 
280
 
 
281
              Specify zero or more arguments, each  with  a  <i>ser-</i>
 
282
              <i>vice-type</i>  name (<b>inet</b>, <b>unix</b>, <b>fifo</b>, or <b>pass</b>) or with
 
283
              a <i>service-name.service-type</i>  pair,  where  <i>service-</i>
 
284
              <i>name</i> is the first field of a <a href="master.5.html">master.cf</a> entry.
 
285
 
 
286
              This  feature  is  available  with  Postfix 2.9 and
 
287
              later.
 
288
 
 
289
       <b>-n</b>     Print <a href="postconf.5.html"><b>main.cf</b></a> parameter settings that  are  explic-
 
290
              itly  specified  in  <a href="postconf.5.html"><b>main.cf</b></a>.   Specify <b>-nf</b> to fold
 
291
              long lines for human readability (Postfix  2.9  and
 
292
              later).
225
293
 
226
294
       <b>-t</b> [<i>template</i><b>_</b><i>file</i>]
227
 
              Display the templates for delivery status notifica-
228
 
              tion  (DSN) messages. To override the built-in tem-
229
 
              plates, specify a template file at the end  of  the
230
 
              command line, or specify a template file in <a href="postconf.5.html">main.cf</a>
231
 
              with the <b><a href="postconf.5.html#bounce_template_file">bounce_template_file</a></b> parameter.  To  force
232
 
              selection  of  the  built-in  templates, specify an
233
 
              empty template file name (in shell language: "").
 
295
              Display  the templates for text that appears at the
 
296
              beginning of  delivery  status  notification  (DSN)
 
297
              messages, without expanding $<b>name</b> expressions.
 
298
 
 
299
              To  override the built-in templates, specify a tem-
 
300
              plate file name at the end of the <a href="postconf.1.html"><b>postconf</b>(1)</a>  com-
 
301
              mand  line,  or specify a file name in <a href="postconf.5.html"><b>main.cf</b></a> with
 
302
              the <b><a href="postconf.5.html#bounce_template_file">bounce_template_file</a></b> parameter.
 
303
 
 
304
              To force selection of the built-in templates, spec-
 
305
              ify  an empty template file name on the <a href="postconf.1.html"><b>postconf</b>(1)</a>
 
306
              command line (in shell language: "").
234
307
 
235
308
              This feature is  available  with  Postfix  2.3  and
236
309
              later.
239
312
              tiple <b>-v</b> options  make  the  software  increasingly
240
313
              verbose.
241
314
 
242
 
       <b>-#</b>     Edit  the  <a href="postconf.5.html"><b>main.cf</b></a>  configuration file. The file is
243
 
              copied to a temporary file then renamed into place.
244
 
              The  parameters  specified  on the command line are
245
 
              commented-out, so that they revert to their default
246
 
              values.  Specify  a  list  of  parameter names, not
247
 
              name=value pairs.  There is no <b>postconf</b> command  to
248
 
              perform the reverse operation.
 
315
       <b>-#</b>     Edit  the  <a href="postconf.5.html"><b>main.cf</b></a>  configuration file, and comment
 
316
              out the parameters given on the <a href="postconf.1.html"><b>postconf</b>(1)</a> command
 
317
              line,  so  that  those  parameters  revert to their
 
318
              default values.  The file is copied to a  temporary
 
319
              file  then  renamed  into place.  Specify a list of
 
320
              parameter names, not <i>name</i>=<i>value</i> pairs.  There is no
 
321
              <a href="postconf.1.html"><b>postconf</b>(1)</a>  command  to perform the reverse opera-
 
322
              tion.
249
323
 
250
 
              This  feature  is  available  with  Postfix 2.6 and
 
324
              This feature is  available  with  Postfix  2.6  and
251
325
              later.
252
326
 
253
327
<b>DIAGNOSTICS</b>
274
348
 
275
349
<b>FILES</b>
276
350
       /etc/postfix/<a href="postconf.5.html">main.cf</a>, Postfix configuration parameters
 
351
       /etc/postfix/<a href="master.5.html">master.cf</a>, Postfix master daemon configuraton
277
352
 
278
353
<b>SEE ALSO</b>
279
354
       <a href="bounce.5.html">bounce(5)</a>, bounce template file format
280
 
       <a href="postconf.5.html">postconf(5)</a>, configuration parameters
 
355
       <a href="master.5.html">master(5)</a>, <a href="master.5.html">master.cf</a> configuration file syntax
 
356
       <a href="postconf.5.html">postconf(5)</a>, <a href="postconf.5.html">main.cf</a> configuration file syntax
281
357
 
282
358
<b>README FILES</b>
283
359
       <a href="DATABASE_README.html">DATABASE_README</a>, Postfix lookup table overview