]> diplodocus.org Git - nmh/blobdiff - man/mh-alias.man
uip/mhshowsbr.h: Move in declarations from h/mhparse.h.
[nmh] / man / mh-alias.man
index 9becac739ea23d3f92696c9e52f0b9e4e0ca1c30..f3c63c7c264c919536b5b6aaae3a97c7e0f0589f 100644 (file)
@@ -1,7 +1,7 @@
-.TH MH-ALIAS %manext5% "Oct 14, 2012" "%nmhversion%"
-.\"
+.TH MH-ALIAS %manext5% 2014-04-18 "%nmhversion%"
+.
 .\" %nmhwarning%
-.\"
+.
 .SH NAME
 mh-alias \- format of nmh alias files
 .SH DESCRIPTION
@@ -13,18 +13,18 @@ alias file takes one of the following forms:
 .RS 5
 .I alias
 .B :
-.I address\-group
+.I address-group
 .RE
 .sp
 .RS 5
 .I alias
 .B ;
-.I address\-group
+.I address-group
 .RE
 .sp
 .RS 5
 .B <
-.I alias\-file
+.I alias-file
 .RE
 .sp
 .RS 5
@@ -40,28 +40,27 @@ where:
 .PP
 .RS 5
 .nf
-.IR address\-group "   := " address\-list
+.IR address-group "    := " address-list
 .RI "                  |  < " file
-.RI "                  |  = " UNIX\-group
-.RI "                  |  + " UNIX\-group
-                       |  *
+.RI "                  |  = " Unix-group
+.RI "                  |  + " Unix-group
 
-.IR address\-list "    := " address
-.RI "                  |  " address\-list ", " address
+.IR address-list "     := " address
+.RI "                  |  " address-list ", " address
 .fi
 .RE
 .PP
 Continuation lines end with \*(lq\\\*(rq followed by a newline
 character.  This also applies to comment lines.  Thus, the line following a
-\*(lq\\\*(rq\-terminated
+\*(lq\\\*(rq-terminated
 comment line is a continuation of
 that comment line.
 .PP
-.I Alias\-file
+.I Alias-file
 and
 .I file
-are UNIX file names.
-.I UNIX\-group
+are Unix file names.
+.I Unix-group
 is a group name or number from
 the system's group database.
 Alias file contents are case-insensitive, with the exception
@@ -72,42 +71,32 @@ read for more alias definitions.  The reading is done recursively, so a
 \*(lq<\*(rq may occur in the beginning of an alias file with the expected results.
 .PP
 If the
-.I address\-group
+.I address-group
 starts with a \*(lq<\*(rq, the file named after the
 \*(lq<\*(rq is read and its contents are added to the
-.I address\-list
+.I address-list
 for the alias.
 .PP
 If the
-.I address\-group
+.I address-group
 starts with an \*(lq=\*(rq, the
 system's group database
-is consulted for the UNIX\-group named after the \*(lq=\*(rq.  Each login name
+is consulted for the Unix-group named after the \*(lq=\*(rq.  Each login name
 occurring as a member of the group is added to the
-.I address\-list
+.I address-list
 for the alias.
 .PP
 In contrast, if the
-.I address\-group
+.I address-group
 starts with a \*(lq+\*(rq, the system's group database
-is consulted to determine the group\-id of the
-UNIX\-group named after the \*(lq+\*(rq.  Each login name occurring in the
+is consulted to determine the group-id of the
+Unix-group named after the \*(lq+\*(rq.  Each login name occurring in the
 system's password database
-whose group\-id is indicated by this group is
+whose group-id is indicated by this group is
 added to the
-.I address\-list
+.I address-list
 for the alias.
 .PP
-If the
-.I address\-group
-is simply \*(lq*\*(rq, the system's password database
-is consulted and all login names with a userid
-greater than some magic number (usually 200) are added to the
-.I address\-list
-for the alias.
-.B
-This feature is obsolescent and will be remove in a future release.
-.PP
 In match, a trailing \*(lq*\*(rq on an alias will match just about anything
 appropriate.
 .PP
@@ -116,14 +105,14 @@ An approximation of the way aliases are resolved at posting time is:
 Build a list of all addresses from the message to be delivered,
 eliminating duplicate addresses.
 .IP 2)
-If this draft originated on the local host, then for those addresses in
-the message that have no host specified, perform alias resolution.
+For those addresses in the message that have no host specified,
+perform alias resolution.
 .IP 3)
 For each line in the alias file, compare \*(lqalias\*(rq against all of
 the existing addresses.  If a match, remove the matched \*(lqalias\*(rq
-from the address list, and add each new address in the address\-group to
+from the address list, and add each new address in the address-group to
 the address list if it is not already on the list.  The alias itself is
-not usually output, rather the address\-group that the alias maps to is
+not usually output, rather the address-group that the alias maps to is
 output instead.  If \*(lqalias\*(rq is terminated with a \*(lq;\*(rq instead of
 a \*(lq:\*(rq, then both the \*(lqalias\*(rq and the address are output in the
 correct format (with the alias quoted if necessary and the address
@@ -138,11 +127,11 @@ Example Alias File
 .PP
 .RS 5
 .nf
-<%etcdir%/BBoardAliases
-fred: frated@UCI.example
+<%nmhetcdir%/BBoardAliases
 sgroup: fred, fear, freida
+fred: frated@UCI.example
 b-people: Blind List: bill, betty
-UNIX\-committee: <unix.aliases
+Unix\-committee: <unix.aliases
 staff: =staff
 wheels: +wheel
 news.*: news
@@ -151,11 +140,10 @@ news.*: news
 .PP
 The first line says that more aliases should immediately be read from
 the file
-.BR %etcdir%/BBoardAliases .
-Following this, \*(lqfred\*(rq
-is defined as an alias for \*(lqfrated@UCI.example\*(rq, and \*(lqsgroup\*(rq
-is defined as an alias for the three names \*(lqfrated@UCI.example\*(rq,
-\*(rqfear\*(rq, and \*(rqfreida\*(rq.
+.BR %nmhetcdir%/BBoardAliases .
+Next, \*(lqsgroup\*(rq is defined as an alias for three names,
+and one of them, \*(lqfred\*(rq,
+is a forward reference to another alias for \*(lqfrated@UCI.example\*(rq.
 .PP
 The alias \*(lqb-people\*(rq is a blind list which includes the addresses
 \*(lqbill\*(rq and \*(lqbetty\*(rq; the message will be delivered to those
@@ -166,25 +154,31 @@ Note that blind lists are not supported with the
 .B sendmail/pipe
 mail transport method.
 .PP
-Next, the definition of \*(lqUNIX\-committee\*(rq is given by
+The definition of \*(lqUnix\-committee\*(rq is given by
 reading the file
 .I unix.aliases
 in the user's
 .B nmh
-directory,
+directory.
+.PP
 \*(lqstaff\*(rq is defined as all users who are listed as members of the
 group \*(lqstaff\*(rq in the
 system's group database, and \*(lqwheels\*(rq
-is defined as all users whose group\-id in
+is defined as all users whose group-id in
 the system's password database
 is equivalent to the \*(lqwheel\*(rq group.
+.PP
+Lastly,
+.RI \*(lqnews. anything \*(rq
+is aliased to \*(lqnews\*(rq;
+the full stop is just another literal character.
 .SH "PROFILE COMPONENTS"
 .TP 20
 Aliasfile:
 Default alias file.
 .SH FILES
 .TP 20
-%etcdir%/MailAliases
+%nmhetcdir%/MailAliases
 System-wide default alias file.
 .SH "SEE ALSO"
 .IR ali (1),
@@ -192,13 +186,12 @@ System-wide default alias file.
 .IR whom (1),
 .IR getgrent (3),
 .IR getpwent (3),
-.IR conflict (8),
 .IR post (8)
 .SH BUGS
 Although the forward-referencing semantics of
 mh\-alias
 files prevent recursion, the
-.B alias\-file
+.B alias-file
 directive may defeat this.
 Since the number of file descriptors is finite, such
 infinite recursion will terminate with a meaningless diagnostic when