NAME
postalias
-
Postfix alias database maintenance
SYNOPSIS
ppoossttaalliiaass [--NNffiinnoopprrssvvww] [--cc _c_o_n_f_i_g___d_i_r]
[--dd _k_e_y] [--qq _k_e_y]
[_f_i_l_e___t_y_p_e:]_f_i_l_e___n_a_m_e ...
DESCRIPTION
The ppoossttaalliiaass(1) command creates or queries one or more Postfix
alias databases, or updates an existing one. The input and output
file formats are expected to be compatible with Sendmail version 8,
and are expected to be suitable for the use as NIS alias maps.
If the result files do not exist they will be created with the
same group and other read permissions as their source file.
While a database update is in progress, signal delivery is
postponed, and an exclusive, advisory, lock is placed on the
entire database, in order to avoid surprises in spectator
processes.
The format of Postfix alias input files is described in
aalliiaasseess(5).
By default the lookup key is mapped to lowercase to make
the lookups case insensitive; as of Postfix 2.3 this case
folding happens only with tables whose lookup keys are
fixed-case strings such as btree:, dbm: or hash:. With
earlier versions, the lookup key is folded even with tables
where a lookup field can match both upper and lower case
text, such as regexp: and pcre:. This resulted in loss of
information with $_n_u_m_b_e_r substitutions.
Options:
-
--cc _c_o_n_f_i_g___d_i_r
Read the mmaaiinn..ccff configuration file in the named directory
-
instead of the default configuration directory.
-
--dd _k_e_y
Search the specified maps for _k_e_y and remove one entry per map.
-
The exit status is zero when the requested information was found.
If a key value of -- is specified, the program reads key
values from the standard input stream. The exit status is zero
when at least one of the requested keys was found.
-
--ff
Do not fold the lookup key to lower case while creating or querying
-
a table.
With Postfix version 2.3 and later, this option has no
effect for regular expression tables. There, case folding
is controlled by appending a flag to a pattern.
-
--ii
Incremental mode. Read entries from standard input and do not
-
truncate an existing database. By default, ppoossttaalliiaass(1) creates
a new database from the entries in _f_i_l_e___n_a_m_e.
-
--NN
Include the terminating null character that terminates lookup keys
-
and values. By default, ppoossttaalliiaass(1) does whatever
is the default for
the host operating system.
-
--nn
Don't include the terminating null character that terminates lookup
-
keys and values. By default, ppoossttaalliiaass(1) does whatever
is the default for
the host operating system.
-
--oo
Do not release root privileges when processing a non-root
-
input file. By default, ppoossttaalliiaass(1) drops root privileges
and runs as the source file owner instead.
-
--pp
Do not inherit the file access permissions from the input file
-
when creating a new file. Instead, create a new file with default
access permissions (mode 0644).
-
--qq _k_e_y
Search the specified maps for _k_e_y and write the first value
-
found to the standard output stream. The exit status is zero
when the requested information was found.
If a key value of -- is specified, the program reads key
values from the standard input stream and writes one line of
_k_e_y_: _v_a_l_u_e output for each key that was found. The exit
status is zero when at least one of the requested keys was found.
-
--rr
When updating a table, do not complain about attempts to update
-
existing entries, and make those updates anyway.
-
--ss
Retrieve all database elements, and write one line of
-
_k_e_y_: _v_a_l_u_e output for each element. The elements are
printed in database order, which is not necessarily the same
as the original input order.
This feature is available in Postfix version 2.2 and later,
and is not available for all database types.
-
--vv
Enable verbose logging for debugging purposes. Multiple --vv
-
options make the software increasingly verbose.
-
--ww
When updating a table, do not complain about attempts to update
-
existing entries, and ignore those attempts.
Arguments:
-
_f_i_l_e___t_y_p_e
The database type. To find out what types are supported, use
-
the "ppoossttccoonnff --mm" command.
The ppoossttaalliiaass(1) command can query any supported file type,
but it can create only the following file types:
-
bbttrreeee
The output is a btree file, named _f_i_l_e___n_a_m_e..ddbb.
-
This is available on systems with support for ddbb databases.
-
ccddbb
The output is one file named _f_i_l_e___n_a_m_e..ccddbb.
-
This is available on systems with support for ccddbb databases.
-
ddbbmm
The output consists of two files, named _f_i_l_e___n_a_m_e..ppaagg and
-
_f_i_l_e___n_a_m_e..ddiirr.
This is available on systems with support for ddbbmm databases.
-
hhaasshh
The output is a hashed file, named _f_i_l_e___n_a_m_e..ddbb.
-
This is available on systems with support for ddbb databases.
-
ssddbbmm
The output consists of two files, named _f_i_l_e___n_a_m_e..ppaagg and
-
_f_i_l_e___n_a_m_e..ddiirr.
This is available on systems with support for ssddbbmm databases.
When no _f_i_l_e___t_y_p_e is specified, the software uses the database
type specified via the ddeeffaauulltt__ddaattaabbaassee__ttyyppee configuration
parameter.
The default value for this parameter depends on the host environment.
-
_f_i_l_e___n_a_m_e
The name of the alias database source file when creating a database.
-
DIAGNOSTICS
Problems are logged to the standard error stream and to
ssyyssllooggdd(8). No output means that
no problems were detected. Duplicate entries are skipped and are
flagged with a warning.
ppoossttaalliiaass(1) terminates with zero exit status in case of success
(including successful "ppoossttaalliiaass --qq" lookup) and terminates
with non-zero exit status in case of failure.
ENVIRONMENT
-
MMAAIILL__CCOONNFFIIGG
Directory with Postfix configuration files.
-
-
MMAAIILL__VVEERRBBOOSSEE
Enable verbose logging for debugging purposes.
-
CONFIGURATION PARAMETERS
The following mmaaiinn..ccff parameters are especially relevant to
this program.
The text below provides only a parameter summary. See
ppoossttccoonnff(5) for more details including examples.
-
aalliiaass__ddaattaabbaassee ((sseeee ''ppoossttccoonnff --dd'' oouuttppuutt))
The alias databases for llooccaall(8) delivery that are updated with
-
"nneewwaalliiaasseess" or with "sseennddmmaaiill --bbii".
-
ccoonnffiigg__ddiirreeccttoorryy ((sseeee ''ppoossttccoonnff --dd'' oouuttppuutt))
The default location of the Postfix main.cf and master.cf
-
configuration files.
-
bbeerrkkeelleeyy__ddbb__ccrreeaattee__bbuuffffeerr__ssiizzee ((1166777777221166))
The per-table I/O buffer size for programs that create Berkeley DB
-
hash or btree tables.
-
bbeerrkkeelleeyy__ddbb__rreeaadd__bbuuffffeerr__ssiizzee ((113311007722))
The per-table I/O buffer size for programs that read Berkeley DB
-
hash or btree tables.
-
ddeeffaauulltt__ddaattaabbaassee__ttyyppee ((sseeee ''ppoossttccoonnff --dd'' oouuttppuutt))
The default database type for use in nneewwaalliiaasseess(1), ppoossttaalliiaass(1)
-
and ppoossttmmaapp(1) commands.
-
ssyysslloogg__ffaacciilliittyy ((mmaaiill))
The syslog facility of Postfix logging.
-
-
ssyysslloogg__nnaammee ((sseeee ''ppoossttccoonnff --dd'' oouuttppuutt))
The mail system name that is prepended to the process name in syslog
-
records, so that "smtpd" becomes, for example, "postfix/smtpd".
STANDARDS
RFC 822 (ARPA Internet Text Messages)
SEE ALSO
aliases(5), format of alias database input file.
local(8), Postfix local delivery agent.
postconf(1), supported database types
postconf(5), configuration parameters
postmap(1), create/update/query lookup tables
newaliases(1), Sendmail compatibility interface.
syslogd(8), system logging
README FILES
Use "ppoossttccoonnff rreeaaddmmee__ddiirreeccttoorryy" or
"ppoossttccoonnff hhttmmll__ddiirreeccttoorryy" to locate this information.
DATABASE_README, Postfix lookup table overview
LICENSE
The Secure Mailer license must be distributed with this software.
AUTHOR(S)
Wietse Venema
IBM T.J. Watson Research
P.O. Box 704
Yorktown Heights, NY 10598, USA