xref: /netbsd-src/external/ibm-public/postfix/dist/html/postconf.1.html (revision 7d3af8c6a2070d16ec6d1aef203d052d6683100d)
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=us-ascii">
5<title> Postfix manual - postconf(1) </title>
6</head> <body> <pre>
7POSTCONF(1)                                                        POSTCONF(1)
8
9<b>NAME</b>
10       postconf - Postfix configuration utility
11
12<b>SYNOPSIS</b>
13       <b>Managing <a href="postconf.5.html">main.cf</a>:</b>
14
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>]
17
18       <b>postconf</b> [<b>-ev</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<i>parameter=value ...</i>]
19
20       <b>postconf</b> [<b>-#v</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<i>parameter ...</i>]
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
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>]
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
34<b>DESCRIPTION</b>
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.
41
42       Options:
43
44       <b>-a</b>     List  the available SASL server plug-in types.  The
45              SASL   plug-in   type   is   selected   with    the
46              <b><a href="postconf.5.html#smtpd_sasl_type">smtpd_sasl_type</a></b> configuration parameter by specify-
47              ing one of the names listed below.
48
49              <b>cyrus</b>  This server plug-in is available when  Post-
50                     fix is built with Cyrus SASL support.
51
52              <b>dovecot</b>
53                     This server plug-in uses the Dovecot authen-
54                     tication server, and is available when Post-
55                     fix  is built with any form of SASL support.
56
57              This feature is  available  with  Postfix  2.3  and
58              later.
59
60       <b>-A</b>     List  the available SASL client plug-in types.  The
61              SASL   plug-in   type   is   selected   with    the
62              <b><a href="postconf.5.html#smtp_sasl_type">smtp_sasl_type</a></b>   or   <b><a href="postconf.5.html#lmtp_sasl_type">lmtp_sasl_type</a></b>  configuration
63              parameters by specifying one of  the  names  listed
64              below.
65
66              <b>cyrus</b>  This  client plug-in is available when Post-
67                     fix is built with Cyrus SASL support.
68
69              This feature is  available  with  Postfix  2.3  and
70              later.
71
72       <b>-b</b> [<i>template</i><b>_</b><i>file</i>]
73              Display the message text that appears at the begin-
74              ning of delivery  status  notification  (DSN)  mes-
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
88              later.
89
90       <b>-c</b> <i>config</i><b>_</b><i>dir</i>
91              The <a href="postconf.5.html"><b>main.cf</b></a> configuration  file  is  in  the  named
92              directory  instead  of  the  default  configuration
93              directory.
94
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
137              methods.  Postfix supports the following methods:
138
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
142                     library.
143
144              <b>fcntl</b>  A  kernel-based  advisory locking method for
145                     local and remote files.
146
147              <b>dotlock</b>
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
153                     were left behind after abnormal termination.
154
155       <b>-m</b>     List the names of all supported lookup table types.
156              In  Postfix  configuration files, lookup tables are
157              specified as <i>type</i><b>:</b><i>name</i>, where <i>type</i> is  one  of  the
158              types  listed  below. The table <i>name</i> syntax depends
159              on the lookup table type as described in the  <a href="DATABASE_README.html">DATA</a>-
160              <a href="DATABASE_README.html">BASE_README</a> document.
161
162              <b>btree</b>  A  sorted, balanced tree structure.  This is
163                     available on systems with support for Berke-
164                     ley DB databases.
165
166              <b>cdb</b>    A  read-optimized  structure with no support
167                     for incremental updates.  This is  available
168                     on systems with support for CDB databases.
169
170              <b>cidr</b>   A  table  that associates values with Class-
171                     less Inter-Domain Routing  (CIDR)  patterns.
172                     This is described in <a href="cidr_table.5.html"><b>cidr_table</b>(5)</a>.
173
174              <b>dbm</b>    An indexed file type based on hashing.  This
175                     is available on systems with support for DBM
176                     databases.
177
178              <b>environ</b>
179                     The  UNIX  process  environment  array.  The
180                     lookup key is the variable name.  Originally
181                     implemented  for  testing,  someone may find
182                     this useful someday.
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
189              <b>hash</b>   An indexed file type based on hashing.  This
190                     is available on  systems  with  support  for
191                     Berkeley DB databases.
192
193              <b>internal</b>
194                     A non-shared, in-memory hash table. Its con-
195                     tent are lost when a process terminates.
196
197              <b>ldap</b> (read-only)
198                     Perform lookups  using  the  LDAP  protocol.
199                     This is described in <a href="ldap_table.5.html"><b>ldap_table</b>(5)</a>.
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
205              <b>mysql</b> (read-only)
206                     Perform lookups using  the  MYSQL  protocol.
207                     This is described in <a href="mysql_table.5.html"><b>mysql_table</b>(5)</a>.
208
209              <b>pcre</b> (read-only)
210                     A lookup table based on Perl Compatible Reg-
211                     ular  Expressions.  The   file   format   is
212                     described in <a href="pcre_table.5.html"><b>pcre_table</b>(5)</a>.
213
214              <b>pgsql</b> (read-only)
215                     Perform  lookups using the PostgreSQL proto-
216                     col. This is described in <a href="pgsql_table.5.html"><b>pgsql_table</b>(5)</a>.
217
218              <b>proxy</b>  A lookup table that is implemented  via  the
219                     Postfix  <a href="proxymap.8.html"><b>proxymap</b>(8)</a> service. The table name
220                     syntax is <i>type</i><b>:</b><i>name</i>.
221
222              <b>regexp</b> (read-only)
223                     A lookup table based on regular expressions.
224                     The  file  format is described in <a href="regexp_table.5.html"><b>regexp_ta-</b></a>
225                     <a href="regexp_table.5.html"><b>ble</b>(5)</a>.
226
227              <b>sdbm</b>   An indexed file type based on hashing.  This
228                     is  available  on  systems  with support for
229                     SDBM databases.
230
231              <b>sqlite</b> (read-only)
232                     Perform lookups from SQLite database  files.
233                     This is described in <a href="sqlite_table.5.html"><b>sqlite_table</b>(5)</a>.
234
235              <b>static</b> (read-only)
236                     A  table  that  always  returns  its name as
237                     lookup result.  For  example,  <b><a href="DATABASE_README.html#types">static</a>:foobar</b>
238                     always  returns  the string <b>foobar</b> as lookup
239                     result.
240
241              <b>tcp</b> (read-only)
242                     Perform lookups using a simple request-reply
243                     protocol  that is described in <a href="tcp_table.5.html"><b>tcp_table</b>(5)</a>.
244
245              <b>texthash</b> (read-only)
246                     Produces similar  results  as  hash:  files,
247                     except  that  you  don't  need  to  run  the
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
250                     after the file is read.
251
252              <b>unix</b> (read-only)
253                     A limited way to query the UNIX  authentica-
254                     tion  database.  The  following  tables  are
255                     implemented:
256
257                     <b>unix:passwd.byname</b>
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
261                            <b>passwd</b>(5) format.
262
263                     <b>unix:group.byname</b>
264                            The table is the UNIX group database.
265                            The key is a group name.  The  result
266                            is  a  group  file  entry in <b>group</b>(5)
267                            format.
268
269              Other table types may exist depending on how  Post-
270              fix was built.
271
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).
293
294       <b>-t</b> [<i>template</i><b>_</b><i>file</i>]
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: "").
307
308              This feature is  available  with  Postfix  2.3  and
309              later.
310
311       <b>-v</b>     Enable verbose logging for debugging purposes. Mul-
312              tiple <b>-v</b> options  make  the  software  increasingly
313              verbose.
314
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.
323
324              This feature is  available  with  Postfix  2.6  and
325              later.
326
327<b>DIAGNOSTICS</b>
328       Problems are reported to the standard error stream.
329
330<b>ENVIRONMENT</b>
331       <b>MAIL_CONFIG</b>
332              Directory with Postfix configuration files.
333
334<b>CONFIGURATION PARAMETERS</b>
335       The  following  <a href="postconf.5.html"><b>main.cf</b></a> parameters are especially relevant
336       to this program.
337
338       The text below provides  only  a  parameter  summary.  See
339       <a href="postconf.5.html"><b>postconf</b>(5)</a> for more details including examples.
340
341       <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
342              The  default  location  of  the Postfix <a href="postconf.5.html">main.cf</a> and
343              <a href="master.5.html">master.cf</a> configuration files.
344
345       <b><a href="postconf.5.html#bounce_template_file">bounce_template_file</a> (empty)</b>
346              Pathname of a configuration file with  bounce  mes-
347              sage templates.
348
349<b>FILES</b>
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
352
353<b>SEE ALSO</b>
354       <a href="bounce.5.html">bounce(5)</a>, bounce template file format
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
357
358<b>README FILES</b>
359       <a href="DATABASE_README.html">DATABASE_README</a>, Postfix lookup table overview
360
361<b>LICENSE</b>
362       The Secure Mailer license must be  distributed  with  this
363       software.
364
365<b>AUTHOR(S)</b>
366       Wietse Venema
367       IBM T.J. Watson Research
368       P.O. Box 704
369       Yorktown Heights, NY 10598, USA
370
371                                                                   POSTCONF(1)
372</pre> </body> </html>
373