contrib/sendmail/src/aliases.5

   1 .\" Copyright (c) 1998-2000 Sendmail, Inc. and its suppliers.
   2 .\"      All rights reserved.
   3 .\" Copyright (c) 1983, 1997 Eric P. Allman.  All rights reserved.
   4 .\" Copyright (c) 1985, 1991, 1993
   5 .\"     The Regents of the University of California.  All rights reserved.
   6 .\"
   7 .\" By using this file, you agree to the terms and conditions set
   8 .\" forth in the LICENSE file which can be found at the top level of
   9 .\" the sendmail distribution.
  10 .\"
  11 .\"
  12 .\"     $Id: aliases.5,v 8.17 2000/12/14 23:09:46 gshapiro Exp $
  13 .\"
  14 .TH ALIASES 5 "$Date: 2000/12/14 23:09:46 $"
  15 .SH NAME
  16 aliases
  17 \- aliases file for sendmail
  18 .SH SYNOPSIS
  19 .B aliases
  20 .SH DESCRIPTION
  21 This file describes user
  22 ID
  23 aliases used by
  24 sendmail.
  25 The file resides in
  26 /etc/mail
  27 and
  28 is formatted as a series of lines of the form
  29 .IP
  30 name: addr_1, addr_2, addr_3, . . .
  31 .PP
  32 The
  33 .I name
  34 is the name to alias, and the
  35 .I addr_n
  36 are the aliases for that name.
  37 .I addr_n
  38 can be another alias, a local username, a local filename,
  39 a command,
  40 an include file,
  41 or an external address.
  42 .TP
  43 .B Local Username
  44 username
  45 .IP
  46 The username must be available via getpwnam(3).
  47 .TP
  48 .B Local Filename
  49 /path/name
  50 .IP
  51 Messages are appended to the file specified by the full pathname
  52 (starting with a slash (/))
  53 .TP
  54 .B Command
  55 |command
  56 .IP
  57 A command starts with a pipe symbol (|),
  58 it receives messages via standard input.
  59 .TP
  60 .B Include File
  61 :include: /path/name
  62 .IP
  63 The aliases in pathname are added to the aliases for
  64 .I name.
  65 .TP
  66 .B E-Mail Address
  67 user@domain
  68 .IP
  69 An e-mail address in RFC 822 format.
  70 .PP
  71 Lines beginning with white space are continuation lines.
  72 Another way to continue lines is by placing a backslash
  73 directly before a newline.
  74 Lines beginning with
  75 #
  76 are comments.
  77 .PP
  78 Aliasing occurs only on local names.
  79 Loops can not occur, since no message will be sent to any person more than once.
  80 .PP
  81 After aliasing has been done, local and valid recipients who have a
  82 ``.forward''
  83 file in their home directory have messages forwarded to the
  84 list of users defined in that file.
  85 .PP
  86 This is only the raw data file; the actual aliasing information is
  87 placed into a binary format in the file
  88 /etc/mail/aliases.db
  89 using the program
  90 newaliases(1).
  91 A
  92 newaliases
  93 command should be executed each time the aliases file is changed for the
  94 change to take effect.
  95 .SH SEE  ALSO
  96 newaliases(1),
  97 dbm(3),
  98 dbopen(3),
  99 db_open(3),
 100 sendmail(8)
 101 .PP
 102 .I
 103 SENDMAIL Installation and Operation Guide.
 104 .PP
 105 .I
 106 SENDMAIL An Internetwork Mail Router.
 107 .SH BUGS
 108 If you have compiled
 109 sendmail
 110 with DBM support instead of NEWDB,
 111 you may have encountered problems in
 112 dbm(3)
 113 restricting a single alias to about 1000 bytes of information.
 114 You can get longer aliases by ``chaining''; that is, make the last name in
 115 the alias be a dummy name which is a continuation alias.
 116 .SH HISTORY
 117 The
 118 .B aliases
 119 file format appeared in
 120 4.0BSD.
 121 .\" $FreeBSD: src/contrib/sendmail/src/aliases.5,v 1.3.6.4 2002/09/03 01:50:15 gshapiro Exp $
 122 .\" $DragonFly: src/contrib/sendmail/src/Attic/aliases.5,v 1.2 2003/06/17 04:24:06 dillon Exp $