git.marmaro.de Git - mmh/blob - man/mh-alias.man

   1 .TH MH-ALIAS %manext5% "Oct 14, 2012" "%nmhversion%"
   2 .\"
   3 .\" %nmhwarning%
   4 .\"
   5 .SH NAME
   6 mh-alias \- alias file for nmh message system
   7 .SH SYNOPSIS
   8 any
   9 .B nmh
  10 command
  11 .SH DESCRIPTION
  12 This describes both
  13 .B nmh
  14 personal alias files and
  15 the global alias file for
  16 .B nmh
  17 mail delivery, the file
  18 .PP
  19 .RS 5
  20 %etcdir%/MailAliases
  21 .RE
  22 .PP
  23 It does
  24 .B not
  25 describe aliases files used by the message transport system.
  26 Each line of the alias file has the format:
  27 .PP
  28 .RS 5
  29 .I alias
  30 .B :
  31 .I address\-group
  32 .RE
  33 or
  34 .RS 5
  35 .I alias
  36 .B ;
  37 .I address\-group
  38 .RE
  39 or
  40 .RS 5
  41 .B <
  42 .I alias\-file
  43 .RE
  44 or
  45 .RS 5
  46 .B ;
  47 |
  48 .B :
  49 |
  50 .B #
  51 .I comment
  52 .RE
  53 .PP
  54 where:
  55 .PP
  56 .RS 5
  57 .nf
  58 .IR address\-group "    := " address\-list
  59 .RI "                   |  < " file
  60 .RI "                   |  = " UNIX\-group
  61 .RI "                   |  + " UNIX\-group
  62                         |  *
  63
  64 .IR address\-list "     := " address
  65 .RI "                   |  " address\-list ", " address
  66 .fi
  67 .RE
  68 .PP
  69 Continuation lines in alias files end with `\\' followed by the newline
  70 character.  This applies to comment lines.  Thus, a line following a
  71 comment line that ends with a `\\' will be treated as a continuation of
  72 the comment.
  73 .PP
  74 .RI \*(lq  Alias\-file \*(rq
  75 and
  76 .RI \*(lq file \*(rq
  77 are UNIX file names.
  78 .I UNIX\-group
  79 is a group name (or number) from
  80 .IR /etc/group .
  81 An address is a \*(lqsimple\*(rq
  82 Internet\-style address.  Througout this file, case is ignored, except
  83 for file names.
  84 .PP
  85 If the line starts with a `<', then the file named after the `<' is
  86 read for more alias definitions.  The reading is done recursively, so a
  87 `<' may occur in the beginning of an alias file with the expected results.
  88 .PP
  89 If the
  90 .I address\-group
  91 starts with a `<', then the file named after the
  92 `<' is read and its contents are added to the
  93 .I address\-list
  94 for the alias.
  95 .PP
  96 If the
  97 .I address\-group
  98 starts with an `=', then the file
  99 .I /etc/group
 100 is consulted for the UNIX\-group named after the `='.  Each login name
 101 occurring as a member of the group is added to the
 102 .I address\-list
 103 for the alias.
 104 .PP
 105 In contrast, if the
 106 .I address\-group
 107 starts with a `+', then the file
 108 .I /etc/group
 109 is consulted to determine the group\-id of the
 110 UNIX\-group named after the `+'.  Each login name occurring in the
 111 .I /etc/passwd
 112 file whose group\-id is indicated by this group is
 113 added to the
 114 .I address\-list
 115 for the alias.
 116 .PP
 117 If the
 118 .I address\-group
 119 is simply `*', then the file
 120 .I /etc/passwd
 121 is consulted and all login names with a userid
 122 greater than some magic number (usually 200) are added to the
 123 .I address\-list
 124 for the alias.
 125 .PP
 126 In match, a trailing \*(lq*\*(rq on an alias will match just about anything
 127 appropriate.  (See example below.)
 128 .PP
 129 An approximation of the way aliases are resolved at posting time is
 130 (it's not really done this way):
 131 .PP
 132 .RS 2
 133 .IP 1) 3
 134 Build a list of all addresses from the message to be delivered,
 135 eliminating duplicate addresses.
 136 .PP
 137 .IP 2) 3
 138 If this draft originated on the local host, then for those addresses in
 139 the message that have no host specified, perform alias resolution.
 140 .PP
 141 .IP 3) 3
 142 For each line in the alias file, compare \*(lqalias\*(rq against all of
 143 the existing addresses.  If a match, remove the matched \*(lqalias\*(rq
 144 from the address list, and add each new address in the address\-group to
 145 the address list if it is not already on the list.  The alias itself is
 146 not usually output, rather the address\-group that the alias maps to is
 147 output instead.  If \*(lqalias\*(rq is terminated with a `;' instead of
 148 a `:', then both the \*(lqalias\*(rq and the address are output in the
 149 correct format (with the alias quoted if necessary and the address
 150 wrapped in <>).
 151 .PP
 152 This makes replies possible since
 153 .B nmh
 154 aliases
 155 and personal aliases are unknown to the mail transport system.
 156 .RE
 157 .PP
 158 Since the alias file is read line by line, forward references work, but
 159 backward references are not recognized, thus, there is no recursion.
 160 .PP
 161 Example Alias File:
 162 .PP
 163 .RS 5
 164 .nf
 165 <%etcdir%/BBoardAliases
 166 sgroup: fred, fear, freida
 167 b-people: Blind List: bill, betty
 168 fred: frated@UCI
 169 UNIX\-committee: <unix.aliases
 170 staff: =staff
 171 wheels: +wheel
 172 everyone: *
 173 news.*: news
 174 .fi
 175 .RE
 176 .PP
 177 The first line says that more aliases should immediately be read from
 178 the file
 179 .IR %etcdir%/BBoardAliases .
 180 Following this, \*(lqfred\*(rq
 181 is defined as an alias for \*(lqfrated@UCI\*(rq, and \*(lqsgroup\*(rq
 182 is defined as an alias for the three names \*(lqfrated@UCI\*(rq,
 183 \*(rqfear\*(rq, and \*(rqfreida\*(rq.
 184 .PP
 185 The alias \*(lqb-people\*(rq is a blind list which includes the addresses
 186 \*(lqbill\*(rq and \*(lqbetty\*(rq; the message will be delivered to those
 187 addresses, but the message header will show only \*(lqBlind List: ;\*(rq
 188 (not the addresses).  The alias must not be terminated with, or contain,
 189 a semicolon; see
 190 .B Helpful Hints
 191 below.  Note that blind lists are not supported with the
 192 .B sendmail/pipe
 193 mail transport method.
 194 .PP
 195 Next, the definition of \*(lqUNIX\-committee\*(rq is given by
 196 reading the file
 197 .I unix.aliases
 198 in the users
 199 .B nmh
 200 directory,
 201 \*(lqstaff\*(rq is defined as all users who are listed as members of the
 202 group \*(lqstaff\*(rq in the
 203 .I /etc/group
 204 file, and \*(lqwheels\*(rq
 205 is defined as all users whose group\-id in
 206 .I /etc/passwd
 207 is equivalent to the \*(lqwheel\*(rq group.
 208 .PP
 209 Finally, \*(lqeveryone\*(rq is defined as all users with a user\-id
 210 in
 211 .I /etc/passwd
 212 greater than 200, and all aliases of the form
 213 \*(lqnews.<anything>\*(rq are defined to be \*(lqnews\*(rq.
 214 .PP
 215 The key thing to understand about aliasing in
 216 .B nmh
 217 is that aliases in
 218 .B nmh
 219 alias files are expanded into the headers of messages posted.
 220 This aliasing occurs first, at posting time, without the knowledge of the
 221 message transport system.  In contrast, once the message transport system
 222 is given a message to deliver to a list of addresses, for each address
 223 that appears to be local, a system\-wide alias file is consulted.  These
 224 aliases are
 225 .B not
 226 expanded into the headers of messages delivered.
 227 .SH "HELPFUL HINTS"
 228 To use aliasing in
 229 .B nmh
 230 quickly, do the following:
 231 .PP
 232 .RS 2
 233 .IP 1) 3
 234 In your
 235 .IR \&.mh\(ruprofile ,
 236 choose a name for your alias file, say
 237 .RI \*(lq aliases \*(rq,
 238 and add the line:
 239 .PP
 240 .RS 5
 241 .nf
 242 Aliasfile: aliases
 243 .\" ali: \-alias aliases
 244 .\" send: \-alias aliases
 245 .\" whom: \-alias aliases
 246 .fi
 247 .RE
 248 .PP
 249 .IP 2) 3
 250 Create the file
 251 .RI \*(lq aliases \*(rq
 252 in your
 253 .B nmh
 254 directory.
 255 .PP
 256 .IP 3) 3
 257 Start adding aliases to your
 258 .RI \*(lq aliases \*(rq
 259 file as appropriate.
 260 .RE
 261 .PP
 262 Earlier versions of this man page showed a semicolon at the end of the
 263 blind list example.  That caused the preceeding alias to not be
 264 expanded.  There must not be a semicolon at the end of, or within, the
 265 address group of a blind list.
 266 .B post
 267 will append the semicolon to the blind list name.
 268 .SH FILES
 269 .fc ^ ~
 270 .nf
 271 .ta \w'%etcdir%/ExtraBigFileName  'u
 272 ^%etcdir%/MailAliases~^global nmh alias file
 273 .fi
 274 .SH "PROFILE COMPONENTS"
 275 .fc ^ ~
 276 .nf
 277 .ta 2.4i
 278 .ta \w'ExtraBigProfileName  'u
 279 ^Aliasfile:~^For a default alias file
 280 .fi
 281 .SH "SEE ALSO"
 282 .IR ali (1),
 283 .IR send (1),
 284 .IR whom (1),
 285 .IR group (5),
 286 .IR passwd (5),
 287 .IR conflict (8),
 288 .IR post (8)
 289 .SH CONTEXT
 290 None
 291 .SH BUGS
 292 Although the forward-referencing semantics of
 293 .B mh\-alias
 294 files prevent recursion, the
 295 .RI \*(lq< " alias\-file" \*(rq
 296 command may defeat this.
 297 Since the number of file descriptors is finite (and very limited), such
 298 infinite recursion will terminate with a meaningless diagnostic when
 299 all the fds are used up.