external/ibm-public/postfix/dist/html/postconf.1.html

   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>
   7 POSTCONF(1)                                                        POSTCONF(1)
   8
   9 <b>NAME</b>
  10        postconf - Postfix configuration utility
  11
  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>]
  14
  15        <b>postconf</b> [<b>-aAmlv</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>]
  16
  17        <b>postconf</b> [<b>-ev</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<i>parameter=value ...</i>]
  18
  19        <b>postconf</b> [<b>-#v</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<i>parameter ...</i>]
  20
  21        <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
  23 <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.
  28
  29        Options:
  30
  31        <b>-a</b>     List the available SASL server plug-in types.   The
  32               SASL    plug-in   type   is   selected   with   the
  33               <b><a href="postconf.5.html#smtpd_sasl_type">smtpd_sasl_type</a></b> configuration parameter by specify-
  34               ing one of the names listed below.
  35
  36               <b>cyrus</b>  This  server plug-in is available when Post-
  37                      fix is built with Cyrus SASL support.
  38
  39               <b>dovecot</b>
  40                      This server plug-in uses the Dovecot authen-
  41                      tication server, and is available when Post-
  42                      fix is built with any form of SASL  support.
  43
  44               This  feature  is  available  with  Postfix 2.3 and
  45               later.
  46
  47        <b>-A</b>     List the available SASL client plug-in types.   The
  48               SASL    plug-in   type   is   selected   with   the
  49               <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
  50               parameters  by  specifying  one of the names listed
  51               below.
  52
  53               <b>cyrus</b>  This client plug-in is available when  Post-
  54                      fix is built with Cyrus SASL support.
  55
  56               This  feature  is  available  with  Postfix 2.3 and
  57               later.
  58
  59        <b>-b</b> [<i>template</i><b>_</b><i>file</i>]
  60               Display the message text that appears at the begin-
  61               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
  72               later.
  73
  74        <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
  76               directory  instead  of  the  default  configuration
  77               directory.
  78
  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        <b>-h</b>     Show  parameter  values  only,  not the ``name = ''
  89               label that normally precedes the value.
  90
  91        <b>-l</b>     List the names of  all  supported  mailbox  locking
  92               methods.  Postfix supports the following methods:
  93
  94               <b>flock</b>  A  kernel-based  advisory locking method for
  95                      local files only.  This  locking  method  is
  96                      available  on  systems with a BSD compatible
  97                      library.
  98
  99               <b>fcntl</b>  A kernel-based advisory locking  method  for
 100                      local and remote files.
 101
 102               <b>dotlock</b>
 103                      An   application-level  locking  method.  An
 104                      application locks a file named  <i>filename</i>  by
 105                      creating  a  file  named <i>filename</i><b>.lock</b>.  The
 106                      application is expected to  remove  its  own
 107                      lock  file, as well as stale lock files that
 108                      were left behind after abnormal termination.
 109
 110        <b>-m</b>     List the names of all supported lookup table types.
 111               In Postfix configuration files, lookup  tables  are
 112               specified  as  <i>type</i><b>:</b><i>name</i>,  where <i>type</i> is one of the
 113               types listed below. The table <i>name</i>  syntax  depends
 114               on  the lookup table type as described in the <a href="DATABASE_README.html">DATA</a>-
 115               <a href="DATABASE_README.html">BASE_README</a> document.
 116
 117               <b>btree</b>  A sorted, balanced tree structure.  This  is
 118                      available on systems with support for Berke-
 119                      ley DB databases.
 120
 121               <b>cdb</b>    A read-optimized structure with  no  support
 122                      for  incremental updates.  This is available
 123                      on systems with support for CDB databases.
 124
 125               <b>cidr</b>   A table that associates values  with  Class-
 126                      less  Inter-Domain  Routing (CIDR) patterns.
 127                      This is described in <a href="cidr_table.5.html"><b>cidr_table</b>(5)</a>.
 128
 129               <b>dbm</b>    An indexed file type based on hashing.  This
 130                      is available on systems with support for DBM
 131                      databases.
 132
 133               <b>environ</b>
 134                      The  UNIX  process  environment  array.  The
 135                      lookup  key is the variable name. Originally
 136                      implemented for testing,  someone  may  find
 137                      this useful someday.
 138
 139               <b>hash</b>   An indexed file type based on hashing.  This
 140                      is available on  systems  with  support  for
 141                      Berkeley DB databases.
 142
 143               <b>ldap</b> (read-only)
 144                      Perform  lookups  using  the  LDAP protocol.
 145                      This is described in <a href="ldap_table.5.html"><b>ldap_table</b>(5)</a>.
 146
 147               <b>mysql</b> (read-only)
 148                      Perform lookups using  the  MYSQL  protocol.
 149                      This is described in <a href="mysql_table.5.html"><b>mysql_table</b>(5)</a>.
 150
 151               <b>pcre</b> (read-only)
 152                      A lookup table based on Perl Compatible Reg-
 153                      ular  Expressions.  The   file   format   is
 154                      described in <a href="pcre_table.5.html"><b>pcre_table</b>(5)</a>.
 155
 156               <b>pgsql</b> (read-only)
 157                      Perform  lookups using the PostgreSQL proto-
 158                      col. This is described in <a href="pgsql_table.5.html"><b>pgsql_table</b>(5)</a>.
 159
 160               <b>proxy</b> (read-only)
 161                      A lookup table that is implemented  via  the
 162                      Postfix  <a href="proxymap.8.html"><b>proxymap</b>(8)</a> service. The table name
 163                      syntax is <i>type</i><b>:</b><i>name</i>.
 164
 165               <b>regexp</b> (read-only)
 166                      A lookup table based on regular expressions.
 167                      The  file  format is described in <a href="regexp_table.5.html"><b>regexp_ta-</b></a>
 168                      <a href="regexp_table.5.html"><b>ble</b>(5)</a>.
 169
 170               <b>sdbm</b>   An indexed file type based on hashing.  This
 171                      is  available  on  systems  with support for
 172                      SDBM databases.
 173
 174               <b>static</b> (read-only)
 175                      A table that  always  returns  its  name  as
 176                      lookup  result.  For  example, <b>static:foobar</b>
 177                      always returns the string <b>foobar</b>  as  lookup
 178                      result.
 179
 180               <b>tcp</b> (read-only)
 181                      Perform lookups using a simple request-reply
 182                      protocol that is described in  <a href="tcp_table.5.html"><b>tcp_table</b>(5)</a>.
 183                      This feature is not included with the stable
 184                      Postfix release.
 185
 186               <b>unix</b> (read-only)
 187                      A limited way to query the UNIX  authentica-
 188                      tion  database.  The  following  tables  are
 189                      implemented:
 190
 191                      <b>unix:passwd.byname</b>
 192                             The table is the UNIX password  data-
 193                             base.  The  key is a login name.  The
 194                             result is a password  file  entry  in
 195                             <b>passwd</b>(5) format.
 196
 197                      <b>unix:group.byname</b>
 198                             The table is the UNIX group database.
 199                             The key is a group name.  The  result
 200                             is  a  group  file  entry in <b>group</b>(5)
 201                             format.
 202
 203               Other table types may exist depending on how  Post-
 204               fix was built.
 205
 206        <b>-n</b>     Print parameter settings that are not left at their
 207               built-in default value, because they are explicitly
 208               specified in <a href="postconf.5.html">main.cf</a>.
 209
 210        <b>-t</b> [<i>template</i><b>_</b><i>file</i>]
 211               Display the templates for delivery status notifica-
 212               tion (DSN) messages. To override the built-in  tem-
 213               plates,  specify  a template file at the end of the
 214               command line, or specify a template file in <a href="postconf.5.html">main.cf</a>
 215               with  the <b><a href="postconf.5.html#bounce_template_file">bounce_template_file</a></b> parameter.  To force
 216               selection of the  built-in  templates,  specify  an
 217               empty template file name (in shell language: "").
 218
 219               This  feature  is  available  with  Postfix 2.3 and
 220               later.
 221
 222        <b>-v</b>     Enable verbose logging for debugging purposes. Mul-
 223               tiple  <b>-v</b>  options  make  the software increasingly
 224               verbose.
 225
 226        <b>-#</b>     Edit the <a href="postconf.5.html"><b>main.cf</b></a> configuration file.  The  file  is
 227               copied to a temporary file then renamed into place.
 228               The parameters specified on the  command  line  are
 229               commented-out, so that they revert to their default
 230               values. Specify a  list  of  parameter  names,  not
 231               name=value  pairs.  There is no <b>postconf</b> command to
 232               perform the reverse operation.
 233
 234               This feature is  available  with  Postfix  2.6  and
 235               later.
 236
 237 <b>DIAGNOSTICS</b>
 238        Problems are reported to the standard error stream.
 239
 240 <b>ENVIRONMENT</b>
 241        <b>MAIL_CONFIG</b>
 242               Directory with Postfix configuration files.
 243
 244 <b>CONFIGURATION PARAMETERS</b>
 245        The  following  <a href="postconf.5.html"><b>main.cf</b></a> parameters are especially relevant
 246        to this program.
 247
 248        The text below provides  only  a  parameter  summary.  See
 249        <a href="postconf.5.html"><b>postconf</b>(5)</a> for more details including examples.
 250
 251        <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
 252               The  default  location  of  the Postfix <a href="postconf.5.html">main.cf</a> and
 253               <a href="master.5.html">master.cf</a> configuration files.
 254
 255        <b><a href="postconf.5.html#bounce_template_file">bounce_template_file</a> (empty)</b>
 256               Pathname of a configuration file with  bounce  mes-
 257               sage templates.
 258
 259 <b>FILES</b>
 260        /etc/postfix/<a href="postconf.5.html">main.cf</a>, Postfix configuration parameters
 261
 262 <b>SEE ALSO</b>
 263        <a href="bounce.5.html">bounce(5)</a>, bounce template file format
 264        <a href="postconf.5.html">postconf(5)</a>, configuration parameters
 265
 266 <b>README FILES</b>
 267        <a href="DATABASE_README.html">DATABASE_README</a>, Postfix lookup table overview
 268
 269 <b>LICENSE</b>
 270        The Secure Mailer license must be  distributed  with  this
 271        software.
 272
 273 <b>AUTHOR(S)</b>
 274        Wietse Venema
 275        IBM T.J. Watson Research
 276        P.O. Box 704
 277        Yorktown Heights, NY 10598, USA
 278
 279                                                                    POSTCONF(1)
 280 </pre> </body> </html>