~ubuntu-branches/ubuntu/feisty/postfix/feisty-security

« back to all changes in this revision

Viewing changes to html/postmap.1.html

  • Committer: Bazaar Package Importer
  • Author(s): LaMont Jones
  • Date: 2006-11-23 22:53:16 UTC
  • Revision ID: james.westby@ubuntu.com-20061123225316-c85kib8ng0vpybqf
Tags: 2.3.4-2
* Fix sasl patch.. Thanks again to Fabian Fagerholm. Closes: #398245
* New ja.po.  Closes: #398599
* New de.po.  Closes: #399918
* New fr.po.  Closes: #399998

Show diffs side-by-side

added added

removed removed

Lines of Context:
10
10
       postmap - Postfix lookup table management
11
11
 
12
12
<b>SYNOPSIS</b>
13
 
       <b>postmap</b> [<b>-Nfinoprsuvw</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<b>-d</b> <i>key</i>] [<b>-q</b> <i>key</i>]
 
13
       <b>postmap</b> [<b>-Nfinoprsvw</b>] [<b>-c</b> <i>config</i><b>_</b><i>dir</i>] [<b>-d</b> <i>key</i>] [<b>-q</b> <i>key</i>]
14
14
               [<i>file</i><b>_</b><i>type</i>:]<i>file</i><b>_</b><i>name</i> ...
15
15
 
16
16
<b>DESCRIPTION</b>
17
17
       The  <a href="postmap.1.html"><b>postmap</b>(1)</a>  command  creates  or  queries one or more
18
18
       Postfix lookup tables, or updates  an  existing  one.  The
19
 
       input  and output file formats are expected to be compati‐
 
19
       input  and output file formats are expected to be compati-
20
20
       ble with:
21
21
 
22
22
           <b>makemap</b> <i>file</i><b>_</b><i>type file</i><b>_</b><i>name</i> &lt; <i>file</i><b>_</b><i>name</i>
33
33
<b>INPUT FILE FORMAT</b>
34
34
       The format of a lookup table input file is as follows:
35
35
 
36
 
       ·      A table entry has the form
 
36
       <b>o</b>      A table entry has the form
37
37
 
38
38
                   <i>key</i> whitespace <i>value</i>
39
39
 
40
 
       ·      Empty  lines and whitespace-only lines are ignored,
 
40
       <b>o</b>      Empty  lines and whitespace-only lines are ignored,
41
41
              as are lines whose first  non-whitespace  character
42
 
              is a ‘#’.
 
42
              is a `#'.
43
43
 
44
 
       ·      A  logical  line starts with non-whitespace text. A
45
 
              line that starts with whitespace continues a  logi‐
 
44
       <b>o</b>      A  logical  line starts with non-whitespace text. A
 
45
              line that starts with whitespace continues a  logi-
46
46
              cal line.
47
47
 
48
 
       The  <i>key</i>  and  <i>value</i> are processed as is, except that sur‐
 
48
       The  <i>key</i>  and  <i>value</i> are processed as is, except that sur-
49
49
       rounding white space is stripped off. Unlike with  Postfix
50
50
       alias  databases,  quotes cannot be used to protect lookup
51
 
       keys that  contain  special  characters  such  as  ‘#’  or
52
 
       whitespace.
 
51
       keys that contain special characters such as `#' or white-
 
52
       space.
53
53
 
54
54
       By  default  the lookup key is mapped to lowercase to make
55
55
       the lookups case insensitive; as of Postfix 2.3 this  case
75
75
              status is zero when at least one of  the  requested
76
76
              keys was found.
77
77
 
78
 
       <b>-f</b>     Do not fold the lookup key to lower case while cre‐
 
78
       <b>-f</b>     Do not fold the lookup key to lower case while cre-
79
79
              ating or querying a table.
80
80
 
81
81
       <b>-i</b>     Incremental mode. Read entries from standard  input
83
83
              default, <a href="postmap.1.html"><b>postmap</b>(1)</a> creates a new database from the
84
84
              entries in <b>file_name</b>.
85
85
 
86
 
       <b>-N</b>     Include  the terminating null character that termi‐
 
86
       <b>-N</b>     Include  the terminating null character that termi-
87
87
              nates  lookup  keys   and   values.   By   default,
88
88
              <a href="postmap.1.html"><b>postmap</b>(1)</a>  does  whatever  is  the default for the
89
89
              host operating system.
90
90
 
91
 
       <b>-n</b>     Don’t include the terminating null  character  that
 
91
       <b>-n</b>     Don't include the terminating null  character  that
92
92
              terminates  lookup  keys  and  values.  By default,
93
93
              <a href="postmap.1.html"><b>postmap</b>(1)</a> does whatever is  the  default  for  the
94
94
              host operating system.
99
99
              instead.
100
100
 
101
101
       <b>-p</b>     Do not inherit the file access permissions from the
102
 
              input file when creating a new file.  Instead, cre‐
 
102
              input file when creating a new file.  Instead, cre-
103
103
              ate a new  file  with  default  access  permissions
104
104
              (mode 0644).
105
105
 
106
106
       <b>-q</b> <i>key</i> Search  the  specified  maps  for <i>key</i> and write the
107
107
              first value found to the  standard  output  stream.
108
 
              The exit status is zero when the requested informa‐
 
108
              The exit status is zero when the requested informa-
109
109
              tion was found.
110
110
 
111
111
              If a key value of <b>-</b> is specified, the program reads
120
120
 
121
121
       <b>-s</b>     Retrieve all database elements, and write one  line
122
122
              of  <i>key value</i> output for each element. The elements
123
 
              are printed in database order, which is not  neces‐
 
123
              are printed in database order, which is not  neces-
124
124
              sarily  the same as the original input order.  This
125
125
              feature is available in  Postfix  version  2.2  and
126
126
              later, and is not available for all database types.
127
127
 
128
 
       <b>-u</b>     Upgrade the database to the current version.
129
 
 
130
 
       <b>-v</b>     Enable verbose logging for debugging purposes. Mul‐
 
128
       <b>-v</b>     Enable verbose logging for debugging purposes. Mul-
131
129
              tiple  <b>-v</b>  options  make  the software increasingly
132
130
              verbose.
133
131
 
138
136
       Arguments:
139
137
 
140
138
       <i>file</i><b>_</b><i>type</i>
141
 
              The database type. To find out what types are  sup‐
 
139
              The database type. To find out what types are  sup-
142
140
              ported, use the "<b>postconf -m</b>" command.
143
141
 
144
142
              The <a href="postmap.1.html"><b>postmap</b>(1)</a> command can query any supported file
168
166
                     databases.
169
167
 
170
168
              When  no  <i>file</i><b>_</b><i>type</i> is specified, the software uses
171
 
              the    database    type    specified    via     the
172
 
              <b><a href="postconf.5.html#default_database_type">default_database_type</a></b> configuration parameter.
 
169
              the database type specified via  the  <b><a href="postconf.5.html#default_database_type">default_data</a>-</b>
 
170
              <b><a href="postconf.5.html#default_database_type">base_type</a></b> configuration parameter.
173
171
 
174
172
       <i>file</i><b>_</b><i>name</i>
175
173
              The  name  of  the  lookup  table  source file when
195
193
<b>CONFIGURATION PARAMETERS</b>
196
194
       The  following  <a href="postconf.5.html"><b>main.cf</b></a> parameters are especially relevant
197
195
       to this program.  The text below provides only a parameter
198
 
       summary.  See <a href="postconf.5.html"><b>postconf</b>(5)</a> for more details including exam‐
 
196
       summary.  See <a href="postconf.5.html"><b>postconf</b>(5)</a> for more details including exam-
199
197
       ples.
200
198
 
201
199
       <b><a href="postconf.5.html#berkeley_db_create_buffer_size">berkeley_db_create_buffer_size</a> (16777216)</b>
206
204
              The  per-table  I/O  buffer  size for programs that
207
205
              read Berkeley DB hash or btree tables.
208
206
 
209
 
       <b><a href="postconf.5.html#config_directory">config_directory</a> (see ’postconf -d’ output)</b>
 
207
       <b><a href="postconf.5.html#config_directory">config_directory</a> (see 'postconf -d' output)</b>
210
208
              The default location of  the  Postfix  <a href="postconf.5.html">main.cf</a>  and
211
209
              <a href="master.5.html">master.cf</a> configuration files.
212
210
 
213
 
       <b><a href="postconf.5.html#default_database_type">default_database_type</a> (see ’postconf -d’ output)</b>
 
211
       <b><a href="postconf.5.html#default_database_type">default_database_type</a> (see 'postconf -d' output)</b>
214
212
              The default database type for use in <a href="newaliases.1.html"><b>newaliases</b>(1)</a>,
215
213
              <a href="postalias.1.html"><b>postalias</b>(1)</a> and <a href="postmap.1.html"><b>postmap</b>(1)</a> commands.
216
214
 
218
216
              The syslog facility of Postfix logging.
219
217
 
220
218
       <b><a href="postconf.5.html#syslog_name">syslog_name</a> (postfix)</b>
221
 
              The mail system name that is prepended to the  pro‐
222
 
              cess  name  in  syslog  records,  so  that  "smtpd"
 
219
              The mail system  name  that  is  prepended  to  the
 
220
              process  name  in  syslog  records, so that "smtpd"
223
221
              becomes, for example, "postfix/smtpd".
224
222
 
225
223
<b>SEE ALSO</b>