Seth Woolley's Man Viewer

postalias(1) - postalias - Postfix alias database maintenance - man 1 postalias

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

POSTALIAS(1)                                                      POSTALIAS(1)



NAME
       postalias - Postfix alias database maintenance

SYNOPSIS
       postalias [-Nfinoprsvw] [-c config_dir] [-d key] [-q key]
               [file_type:]file_name ...

DESCRIPTION
       The  postalias(1)  command creates or queries one or more Postfix alias
       databases, or updates an existing one. The input and output  file(1,n)  for-
       mats  are  expected  to  be compatible with Sendmail version(1,3,5) 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(2,n,1 builtins) permissions as the source file.

       While  a  database update(7,n) is in(1,8) progress, signal(2,7) delivery is postponed,
       and an exclusive, advisory, lock is placed on the entire  database,  in(1,8)
       order to avoid surprises in(1,8) spectator programs.

       The format of Postfix alias input files is described in(1,8) aliases(5).

       Options:

       -c config_dir
              Read  the  main.cf  configuration  file(1,n)  in(1,8)  the named(5,8) directory
              instead of the default configuration directory.

       -d key Search the specified maps for key and remove one entry per  map.
              The  exit(3,n,1 builtins)  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(3,n,1 builtins) status is zero when at
              least one of the requested keys was found.

       -f     Do not fold the lookup key  to  lower  case  while  creating  or
              querying a map.

       -i     Incremental  mode.  Read  entries from standard input and do not
              truncate(2,7) an existing database. By default, postalias(1)  creates
              a new database from the entries in(1,8) file_name.

       -N     Include  the  terminating  null character that terminates lookup
              keys and values. By default, postalias(1) does whatever  is  the
              default for the host(1,5) operating system.

       -n     Don't  include  the  terminating  null character that terminates
              lookup keys and values. By default, postalias(1)  does  whatever
              is the default for the host(1,5) operating system.

       -o     Do  not release root privileges when processing a non-root input
              file. By default, postalias(1) drops root privileges and runs as
              the source file(1,n) owner instead.

       -p     Do  not  inherit the file(1,n) access(2,5) permissions from the input file(1,n)
              when creating a new file.   Instead,  create  a  new  file(1,n)  with
              default access(2,5) permissions (mode 0644).

       -q key Search  the  specified  maps  for  key and write(1,2) the first value
              found to the standard output stream. The  exit(3,n,1 builtins)  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 key: value
              output for each key that was found. The exit(3,n,1 builtins) status is zero when
              at least one of the requested keys was found.

       -r     When updating a table, do not complain about attempts to  update(7,n)
              existing entries, and make those updates anyway.

       -s     Retrieve all database elements, and write(1,2) one line of key: value
              output for each element. The elements are  printed  in(1,8)  database
              order,  which  is not necessarily the same as the original input
              order.  This feature is available in(1,8)  Postfix  version(1,3,5)  2.2  and
              later, and is not available for all database types.

       -v     Enable  verbose  logging  for  debugging  purposes.  Multiple -v
              options make the software increasingly verbose.

       -w     When updating a table, do not complain about attempts to  update(7,n)
              existing entries, and ignore those attempts.

       Arguments:

       file_type
              The database type. To find out what types are supported, use the
              "postconf(1,5) -m" command.

              The postalias(1) command can query any supported file(1,n) type,  but
              it can create only the following file(1,n) types:

              btree  The  output is a btree file(1,n), named(5,8) file_name.db.  This is
                     available on systems with support for db databases.

              cdb    The output is one  file(1,n)  named(5,8)  file_name.cdb.   This  is
                     available on systems with support for cdb databases.

              dbm    The output consists of two files, named(5,8) file_name.pag and
                     file_name.dir.  This is available on systems with support
                     for dbm databases.

              hash   The output is a hashed file(1,n), named(5,8) file_name.db.  This is
                     available on systems with support for db databases.

              sdbm   The output consists of two files, named(5,8) file_name.pag and
                     file_name.dir.  This is available on systems with support
                     for sdbm databases.

              When no file_type is specified, the software uses  the  database
              type   specified  via  the  default_database_type  configuration
              parameter.  The default value for this parameter depends on  the
              host(1,5) environment.

       file_name
              The name of the alias database source file(1,n) when creating a data-
              base.

DIAGNOSTICS
       Problems are logged to the standard error(8,n) stream and to syslogd(8).  No
       output  means  that  no  problems  were detected. Duplicate entries are
       skipped and are flagged with a warning.

       postalias(1) terminates with  zero  exit(3,n,1 builtins)  status  in(1,8)  case  of  success
       (including  successful  "postalias -q" lookup) and terminates with non-
       zero exit(3,n,1 builtins) status in(1,8) case of failure.

ENVIRONMENT
       MAIL_CONFIG
              Directory with Postfix configuration files.

       MAIL_VERBOSE
              Enable verbose logging for debugging purposes.

CONFIGURATION PARAMETERS
       The following main.cf parameters are especially relevant to  this  pro-
       gram.

       The  text  below provides only a parameter summary. See postconf(1,5)(5) for
       more details including examples.

       alias_database (see 'postconf(1,5) -d' output)
              The alias databases for local(8) delivery that are updated  with
              "newaliases" or with "sendmail(1,8) -bi".

       config_directory (see 'postconf(1,5) -d' output)
              The  default  location of the Postfix main.cf and master.cf con-
              figuration files.

       berkeley_db_create_buffer_size (16777216)
              The per-table I/O buffer size for programs that create  Berkeley
              DB hash or btree tables.

       berkeley_db_read_buffer_size (131072)
              The per-table I/O buffer size for programs that read(2,n,1 builtins) Berkeley DB
              hash or btree tables.

       default_database_type (see 'postconf(1,5) -d' output)
              The default database type for use in(1,8) newaliases(1), postalias(1)
              and postmap(1) commands.

       syslog_facility (mail(1,8))
              The syslog(2,3,5,3 Sys::Syslog) facility of Postfix logging.

       syslog_name (postfix)
              The  mail(1,8)  system  name that is prepended to the process name in(1,8)
              syslog(2,3,5,3 Sys::Syslog) records, so that "smtpd"  becomes,  for  example,  "post-
              fix/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,5)(1), supported database types
       postconf(1,5)(5), configuration parameters
       postmap(1), create/update(7,n)/query lookup tables
       newaliases(1), Sendmail compatibility interface.
       syslogd(8), system logging

README FILES
       Use  "postconf(1,5) readme_directory" or "postconf(1,5) html_directory" 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



                                                                  POSTALIAS(1)

References for this manual (incoming links)