~ubuntu-branches/ubuntu/saucy/postfix/saucy

« back to all changes in this revision

Viewing changes to html/postconf.1.html

  • Committer: Bazaar Package Importer
  • Author(s): LaMont Jones
  • Date: 2011-02-22 11:20:43 UTC
  • mfrom: (1.1.27 upstream)
  • Revision ID: james.westby@ubuntu.com-20110222112043-c34ht219w3ybrilr
Tags: 2.8.0-2
* a little more lintian cleanup
* Fix missing format strings in smtp-sink.c

Show diffs side-by-side

added added

removed removed

Lines of Context:
85
85
              line.  Use  quotes  in  order  to   protect   shell
86
86
              metacharacters and whitespace.
87
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
 
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
92
95
              methods.  Postfix supports the following methods:
93
96
 
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
              <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
97
100
                     library.
98
101
 
99
 
              <b>fcntl</b>  A kernel-based advisory locking  method  for
 
102
              <b>fcntl</b>  A  kernel-based  advisory locking method for
100
103
                     local and remote files.
101
104
 
102
105
              <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
 
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
108
111
                     were left behind after abnormal termination.
109
112
 
110
113
       <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>-
 
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>-
115
118
              <a href="DATABASE_README.html">BASE_README</a> document.
116
119
 
117
 
              <b>btree</b>  A sorted, balanced tree structure.  This  is
 
120
              <b>btree</b>  A  sorted, balanced tree structure.  This is
118
121
                     available on systems with support for Berke-
119
122
                     ley DB databases.
120
123
 
121
 
              <b>cdb</b>    A read-optimized structure with  no  support
122
 
                     for  incremental updates.  This is available
 
124
              <b>cdb</b>    A  read-optimized  structure with no support
 
125
                     for incremental updates.  This is  available
123
126
                     on systems with support for CDB databases.
124
127
 
125
 
              <b>cidr</b>   A table that associates values  with  Class-
126
 
                     less  Inter-Domain  Routing (CIDR) patterns.
 
128
              <b>cidr</b>   A  table  that associates values with Class-
 
129
                     less Inter-Domain Routing  (CIDR)  patterns.
127
130
                     This is described in <a href="cidr_table.5.html"><b>cidr_table</b>(5)</a>.
128
131
 
129
132
              <b>dbm</b>    An indexed file type based on hashing.  This
132
135
 
133
136
              <b>environ</b>
134
137
                     The  UNIX  process  environment  array.  The
135
 
                     lookup  key is the variable name. Originally
136
 
                     implemented for testing,  someone  may  find
 
138
                     lookup key is the variable name.  Originally
 
139
                     implemented  for  testing,  someone may find
137
140
                     this useful someday.
138
141
 
139
142
              <b>hash</b>   An indexed file type based on hashing.  This
140
 
                     is available on  systems  with  support  for
 
143
                     is  available  on  systems  with support for
141
144
                     Berkeley DB databases.
142
145
 
143
146
              <b>internal</b>
145
148
                     tent are lost when a process terminates.
146
149
 
147
150
              <b>ldap</b> (read-only)
148
 
                     Perform lookups  using  the  LDAP  protocol.
 
151
                     Perform  lookups  using  the  LDAP protocol.
149
152
                     This is described in <a href="ldap_table.5.html"><b>ldap_table</b>(5)</a>.
150
153
 
151
154
              <b>mysql</b> (read-only)
152
 
                     Perform  lookups  using  the MYSQL protocol.
 
155
                     Perform lookups using  the  MYSQL  protocol.
153
156
                     This is described in <a href="mysql_table.5.html"><b>mysql_table</b>(5)</a>.
154
157
 
155
158
              <b>pcre</b> (read-only)
156
159
                     A lookup table based on Perl Compatible Reg-
157
 
                     ular   Expressions.   The   file  format  is
 
160
                     ular  Expressions.  The   file   format   is
158
161
                     described in <a href="pcre_table.5.html"><b>pcre_table</b>(5)</a>.
159
162
 
160
163
              <b>pgsql</b> (read-only)
161
 
                     Perform lookups using the PostgreSQL  proto-
 
164
                     Perform  lookups using the PostgreSQL proto-
162
165
                     col. This is described in <a href="pgsql_table.5.html"><b>pgsql_table</b>(5)</a>.
163
166
 
164
167
              <b>proxy</b> (read-only)
165
 
                     A  lookup  table that is implemented via the
166
 
                     Postfix <a href="proxymap.8.html"><b>proxymap</b>(8)</a> service. The table  name
 
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
167
170
                     syntax is <i>type</i><b>:</b><i>name</i>.
168
171
 
169
172
              <b>regexp</b> (read-only)
170
173
                     A lookup table based on regular expressions.
171
 
                     The file format is described  in  <a href="regexp_table.5.html"><b>regexp_ta-</b></a>
 
174
                     The  file  format is described in <a href="regexp_table.5.html"><b>regexp_ta-</b></a>
172
175
                     <a href="regexp_table.5.html"><b>ble</b>(5)</a>.
173
176
 
174
177
              <b>sdbm</b>   An indexed file type based on hashing.  This
175
 
                     is available on  systems  with  support  for
 
178
                     is  available  on  systems  with support for
176
179
                     SDBM databases.
177
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
 
178
185
              <b>static</b> (read-only)
179
186
                     A  table  that  always  returns  its name as
180
187
                     lookup result.  For  example,  <b>static:foobar</b>
184
191
              <b>tcp</b> (read-only)
185
192
                     Perform lookups using a simple request-reply
186
193
                     protocol  that is described in <a href="tcp_table.5.html"><b>tcp_table</b>(5)</a>.
187
 
                     This feature is not included with the stable
188
 
                     Postfix release.
 
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.
189
201
 
190
202
              <b>unix</b> (read-only)
191
 
                     A  limited way to query the UNIX authentica-
 
203
                     A limited way to query the UNIX  authentica-
192
204
                     tion  database.  The  following  tables  are
193
205
                     implemented:
194
206
 
195
207
                     <b>unix:passwd.byname</b>
196
 
                            The  table is the UNIX password data-
197
 
                            base. The key is a login  name.   The
198
 
                            result  is  a  password file entry in
 
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
199
211
                            <b>passwd</b>(5) format.
200
212
 
201
213
                     <b>unix:group.byname</b>
202
214
                            The table is the UNIX group database.
203
 
                            The  key is a group name.  The result
204
 
                            is a group  file  entry  in  <b>group</b>(5)
 
215
                            The key is a group name.  The  result
 
216
                            is  a  group  file  entry in <b>group</b>(5)
205
217
                            format.
206
218
 
207
 
              Other  table types may exist depending on how Post-
 
219
              Other table types may exist depending on how  Post-
208
220
              fix was built.
209
221
 
210
222
       <b>-n</b>     Print parameter settings that are not left at their
213
225
 
214
226
       <b>-t</b> [<i>template</i><b>_</b><i>file</i>]
215
227
              Display the templates for delivery status notifica-
216
 
              tion  (DSN) messages. To override the built-in tem-
217
 
              plates, specify a template file at the end  of  the
 
228
              tion (DSN) messages. To override the built-in  tem-
 
229
              plates,  specify  a template file at the end of the
218
230
              command line, or specify a template file in <a href="postconf.5.html">main.cf</a>
219
 
              with the <b><a href="postconf.5.html#bounce_template_file">bounce_template_file</a></b> parameter.  To  force
220
 
              selection  of  the  built-in  templates, specify an
 
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
221
233
              empty template file name (in shell language: "").
222
234
 
223
 
              This feature is  available  with  Postfix  2.3  and
 
235
              This  feature  is  available  with  Postfix 2.3 and
224
236
              later.
225
237
 
226
238
       <b>-v</b>     Enable verbose logging for debugging purposes. Mul-
227
 
              tiple <b>-v</b> options  make  the  software  increasingly
 
239
              tiple  <b>-v</b>  options  make  the software increasingly
228
240
              verbose.
229
241
 
230
 
       <b>-#</b>     Edit  the  <a href="postconf.5.html"><b>main.cf</b></a>  configuration file. The file is
 
242
       <b>-#</b>     Edit the <a href="postconf.5.html"><b>main.cf</b></a> configuration file.  The  file  is
231
243
              copied to a temporary file then renamed into place.
232
 
              The  parameters  specified  on the command line are
 
244
              The parameters specified on the  command  line  are
233
245
              commented-out, so that they revert to their default
234
 
              values.  Specify  a  list  of  parameter names, not
235
 
              name=value pairs.  There is no <b>postconf</b> command  to
 
246
              values. Specify a  list  of  parameter  names,  not
 
247
              name=value  pairs.  There is no <b>postconf</b> command to
236
248
              perform the reverse operation.
237
249
 
238
 
              This  feature  is  available  with  Postfix 2.6 and
 
250
              This feature is  available  with  Postfix  2.6  and
239
251
              later.
240
252
 
241
253
<b>DIAGNOSTICS</b>
246
258
              Directory with Postfix configuration files.
247
259
 
248
260
<b>CONFIGURATION PARAMETERS</b>
249
 
       The following <a href="postconf.5.html"><b>main.cf</b></a> parameters are  especially  relevant
 
261
       The  following  <a href="postconf.5.html"><b>main.cf</b></a> parameters are especially relevant
250
262
       to this program.
251
263
 
252
 
       The  text  below  provides  only  a parameter summary. See
 
264
       The text below provides  only  a  parameter  summary.  See
253
265
       <a href="postconf.5.html"><b>postconf</b>(5)</a> for more details including examples.
254
266
 
255
267
       <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
256
 
              The default location of  the  Postfix  <a href="postconf.5.html">main.cf</a>  and
 
268
              The  default  location  of  the Postfix <a href="postconf.5.html">main.cf</a> and
257
269
              <a href="master.5.html">master.cf</a> configuration files.
258
270
 
259
271
       <b><a href="postconf.5.html#bounce_template_file">bounce_template_file</a> (empty)</b>
260
 
              Pathname  of  a configuration file with bounce mes-
 
272
              Pathname of a configuration file with  bounce  mes-
261
273
              sage templates.
262
274
 
263
275
<b>FILES</b>
271
283
       <a href="DATABASE_README.html">DATABASE_README</a>, Postfix lookup table overview
272
284
 
273
285
<b>LICENSE</b>
274
 
       The  Secure  Mailer  license must be distributed with this
 
286
       The Secure Mailer license must be  distributed  with  this
275
287
       software.
276
288
 
277
289
<b>AUTHOR(S)</b>