postfix-master/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               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 = " label</i>
  92               <i>that normally precedes the value.</i>
  93
  94        <b>-l</b>     List  the  names  of  all supported mailbox locking
  95               methods.  Postfix supports the following methods:
  96
  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
 100                      library.
 101
 102               <b>fcntl</b>  A  kernel-based  advisory locking method for
 103                      local and remote files.
 104
 105               <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
 111                      were left behind after abnormal termination.
 112
 113        <b>-m</b>     List the names of all supported lookup table types.
 114               In  Postfix  configuration files, lookup tables are
 115               specified as <i>type</i><b>:</b><i>name</i>, where <i>type</i> is  one  of  the
 116               types  listed  below. The table <i>name</i> syntax depends
 117               on the lookup table type as described in the  <a href="DATABASE_README.html">DATA</a>-
 118               <a href="DATABASE_README.html">BASE_README</a> document.
 119
 120               <b>btree</b>  A  sorted, balanced tree structure.  This is
 121                      available on systems with support for Berke-
 122                      ley DB databases.
 123
 124               <b>cdb</b>    A  read-optimized  structure with no support
 125                      for incremental updates.  This is  available
 126                      on systems with support for CDB databases.
 127
 128               <b>cidr</b>   A  table  that associates values with Class-
 129                      less Inter-Domain Routing  (CIDR)  patterns.
 130                      This is described in <a href="cidr_table.5.html"><b>cidr_table</b>(5)</a>.
 131
 132               <b>dbm</b>    An indexed file type based on hashing.  This
 133                      is available on systems with support for DBM
 134                      databases.
 135
 136               <b>environ</b>
 137                      The  UNIX  process  environment  array.  The
 138                      lookup key is the variable name.  Originally
 139                      implemented  for  testing,  someone may find
 140                      this useful someday.
 141
 142               <b>hash</b>   An indexed file type based on hashing.  This
 143                      is  available  on  systems  with support for
 144                      Berkeley DB databases.
 145
 146               <b>internal</b>
 147                      A non-shared, in-memory hash table. Its con-
 148                      tent are lost when a process terminates.
 149
 150               <b>ldap</b> (read-only)
 151                      Perform  lookups  using  the  LDAP protocol.
 152                      This is described in <a href="ldap_table.5.html"><b>ldap_table</b>(5)</a>.
 153
 154               <b>mysql</b> (read-only)
 155                      Perform lookups using  the  MYSQL  protocol.
 156                      This is described in <a href="mysql_table.5.html"><b>mysql_table</b>(5)</a>.
 157
 158               <b>pcre</b> (read-only)
 159                      A lookup table based on Perl Compatible Reg-
 160                      ular  Expressions.  The   file   format   is
 161                      described in <a href="pcre_table.5.html"><b>pcre_table</b>(5)</a>.
 162
 163               <b>pgsql</b> (read-only)
 164                      Perform  lookups using the PostgreSQL proto-
 165                      col. This is described in <a href="pgsql_table.5.html"><b>pgsql_table</b>(5)</a>.
 166
 167               <b>proxy</b> (read-only)
 168                      A lookup table that is implemented  via  the
 169                      Postfix  <a href="proxymap.8.html"><b>proxymap</b>(8)</a> service. The table name
 170                      syntax is <i>type</i><b>:</b><i>name</i>.
 171
 172               <b>regexp</b> (read-only)
 173                      A lookup table based on regular expressions.
 174                      The  file  format is described in <a href="regexp_table.5.html"><b>regexp_ta-</b></a>
 175                      <a href="regexp_table.5.html"><b>ble</b>(5)</a>.
 176
 177               <b>sdbm</b>   An indexed file type based on hashing.  This
 178                      is  available  on  systems  with support for
 179                      SDBM databases.
 180
 181               <b>sqlite</b> (read-only)
 182                      Perform lookups from SQLite database  files.
 183                      This is described in <a href="sqlite_table.5.html"><b>sqlite_table</b>(5)</a>.
 184
 185               <b>static</b> (read-only)
 186                      A  table  that  always  returns  its name as
 187                      lookup result.  For  example,  <b>static:foobar</b>
 188                      always  returns  the string <b>foobar</b> as lookup
 189                      result.
 190
 191               <b>tcp</b> (read-only)
 192                      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>.
 194
 195               <b>texthash</b> (read-only)
 196                      Produces similar  results  as  hash:  files,
 197                      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
 200                      after the file is read.
 201
 202               <b>unix</b> (read-only)
 203                      A limited way to query the UNIX  authentica-
 204                      tion  database.  The  following  tables  are
 205                      implemented:
 206
 207                      <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
 211                             <b>passwd</b>(5) format.
 212
 213                      <b>unix:group.byname</b>
 214                             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)
 217                             format.
 218
 219               Other table types may exist depending on how  Post-
 220               fix was built.
 221
 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>.
 225
 226        <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: "").
 234
 235               This  feature  is  available  with  Postfix 2.3 and
 236               later.
 237
 238        <b>-v</b>     Enable verbose logging for debugging purposes. Mul-
 239               tiple  <b>-v</b>  options  make  the software increasingly
 240               verbose.
 241
 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.
 249
 250               This feature is  available  with  Postfix  2.6  and
 251               later.
 252
 253 <b>DIAGNOSTICS</b>
 254        Problems are reported to the standard error stream.
 255
 256 <b>ENVIRONMENT</b>
 257        <b>MAIL_CONFIG</b>
 258               Directory with Postfix configuration files.
 259
 260 <b>CONFIGURATION PARAMETERS</b>
 261        The  following  <a href="postconf.5.html"><b>main.cf</b></a> parameters are especially relevant
 262        to this program.
 263
 264        The text below provides  only  a  parameter  summary.  See
 265        <a href="postconf.5.html"><b>postconf</b>(5)</a> for more details including examples.
 266
 267        <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
 268               The  default  location  of  the Postfix <a href="postconf.5.html">main.cf</a> and
 269               <a href="master.5.html">master.cf</a> configuration files.
 270
 271        <b><a href="postconf.5.html#bounce_template_file">bounce_template_file</a> (empty)</b>
 272               Pathname of a configuration file with  bounce  mes-
 273               sage templates.
 274
 275 <b>FILES</b>
 276        /etc/postfix/<a href="postconf.5.html">main.cf</a>, Postfix configuration parameters
 277
 278 <b>SEE ALSO</b>
 279        <a href="bounce.5.html">bounce(5)</a>, bounce template file format
 280        <a href="postconf.5.html">postconf(5)</a>, configuration parameters
 281
 282 <b>README FILES</b>
 283        <a href="DATABASE_README.html">DATABASE_README</a>, Postfix lookup table overview
 284
 285 <b>LICENSE</b>
 286        The Secure Mailer license must be  distributed  with  this
 287        software.
 288
 289 <b>AUTHOR(S)</b>
 290        Wietse Venema
 291        IBM T.J. Watson Research
 292        P.O. Box 704
 293        Yorktown Heights, NY 10598, USA
 294
 295                                                                    POSTCONF(1)
 296 </pre> </body> </html>