X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/2c1aaf8b1495d2c7368b47edb04e9a2b7628377b..a9bb157da7d3cee576e8944eaf8fab2bdbc4be8d:/man/mh-alias.man?ds=sidebyside

diff --git a/man/mh-alias.man b/man/mh-alias.man
index 0ee7cd4b..f3c63c7c 100644
--- a/man/mh-alias.man
+++ b/man/mh-alias.man
@@ -1,198 +1,205 @@
-.\"
+.TH MH-ALIAS %manext5% 2014-04-18 "%nmhversion%"
+.
 .\" %nmhwarning%
-.\" $Id$
-.\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
-.TH MH-ALIAS %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
+.
 .SH NAME
-mh-alias \- alias file for nmh message system
-.SH SYNOPSIS
-.in +.5i
-.ti -.5i
-any \fInmh\fR command
-.in -.5i
+mh-alias \- format of nmh alias files
 .SH DESCRIPTION
-This describes both \fInmh\fR personal alias files and
-the global alias file for nmh mail delivery, the file
-
-	%etcdir%/MailAliases
-
-It does \fBnot\fR describe aliases files used by the message transport system.
-Each line of the alias file has the format:
-
-	alias : address\-group
-.br
-or
-.br
-	alias ; address\-group
-.br
-or
-.br
-	< alias\-file
-.br
-or
-.br
-	; comment
-.br
-
+.PP
+Each line of an
+.B nmh
+alias file takes one of the following forms:
+.PP
+.RS 5
+.I alias
+.B :
+.I address-group
+.RE
+.sp
+.RS 5
+.I alias
+.B ;
+.I address-group
+.RE
+.sp
+.RS 5
+.B <
+.I alias-file
+.RE
+.sp
+.RS 5
+.B ;
+|
+.B :
+|
+.B #
+.I comment
+.RE
+.PP
 where:
+.PP
+.RS 5
+.nf
+.IR address-group "	:= " address-list
+.RI "			|  < " file
+.RI "			|  = " Unix-group
+.RI "			|  + " Unix-group
 
-	address\-group  :=  address\-list
-.br
-		       |   \*(lq<\*(rq file
-.br
-		       |   \*(lq=\*(rq UNIX\-group
-.br
-		       |   \*(lq+\*(rq UNIX\-group
-.br
-		       |   \*(lq*\*(rq
-
-.br
-	address\-list   :=  address
-.br
-		       |   address\-list, address
-.br
-
-Continuation lines in alias files end with `\\' followed by the newline
-character.
-
-Alias\-file and file are UNIX file names.  UNIX\-group is a group name
-(or number) from \fI/etc/group\fR.  An address is a \*(lqsimple\*(rq
-Internet\-style address.  Througout this file, case is ignored, except
-for alias\-file names.
-
-If the line starts with a `<', then the file named after the `<' is
+.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
+comment line is a continuation of
+that comment line.
+.PP
+.I Alias-file
+and
+.I file
+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
+of filesystem path names.
+.PP
+If the line starts with a \*(lq<\*(rq, the file named after the \*(lq<\*(rq is
 read for more alias definitions.  The reading is done recursively, so a
-`<' may occur in the beginning of an alias file with the expected results.
-
-If the address\-group starts with a `<', then the file named after the
-`<' is read and its contents are added to the address\-list for the alias.
-
-If the address\-group starts with an `=', then the file \fI/etc/group\fR
-is consulted for the UNIX\-group named after the `='.  Each login name
-occurring as a member of the group is added to the address\-list for
-the alias.
-
-In contrast, if the address\-group starts with a `+', then the file
-\fI/etc/group\fR is consulted to determine the group\-id of the
-UNIX\-group named after the `+'.  Each login name occurring in the
-\fI/etc/passwd\fR file whose group\-id is indicated by this group is
-added to the address\-list for the alias.
-
-If the address\-group is simply `*', then the file \fI/etc/passwd\fR is
-consulted and all login names with a userid greater than some magic number
-(usually 200) are added to the address\-list for the alias.
-
-In match, a trailing * on an alias will match just about anything
-appropriate.  (See example below.)
-
-An approximation of the way aliases are resolved at posting time is
-(it's not really done this way):
-
-.in +.5i
-1) Build a list of all addresses from the message to be delivered,
+\*(lq<\*(rq may occur in the beginning of an alias file with the expected results.
+.PP
+If the
+.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
+for the alias.
+.PP
+If the
+.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
+occurring as a member of the group is added to the
+.I address-list
+for the alias.
+.PP
+In contrast, if the
+.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
+system's password database
+whose group-id is indicated by this group is
+added to the
+.I address-list
+for the alias.
+.PP
+In match, a trailing \*(lq*\*(rq on an alias will match just about anything
+appropriate.
+.PP
+An approximation of the way aliases are resolved at posting time is:
+.IP 1)
+Build a list of all addresses from the message to be delivered,
 eliminating duplicate addresses.
-
-2) If this draft originated on the local host, then for those addresses in
-the message that have no host specified, perform alias resolution.
-
-3) For each line in the alias file, compare \*(lqalias\*(rq against all of
+.IP 2)
+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
-output instead.  If \*(lqalias\*(rq is terminated with a `;' instead of
-a `:', then both the \*(lqalias\*(rq and the address are output in the
-correct format.  (This makes replies possible since \fInmh\fR aliases
-and personal aliases are unknown to the mail transport system.)
-.in -.5i
-
-Since the alias file is read line by line, forward references work, but
-backward references are not recognized, thus, there is no recursion.
-
-.ne 10
-\fBExample:\fR
+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
+wrapped in <>).
+.PP
+Since the
+.I mh-alias
+file is read line by line, forward references work, but
+backward references are not recognized.
+.SS
+Example Alias File
+.PP
+.RS 5
 .nf
-.in +.5i
-<%etcdir%/BBoardAliases
+<%nmhetcdir%/BBoardAliases
 sgroup: fred, fear, freida
-b-people: Blind List: bill, betty;
-fred: frated@UCI
-UNIX\-committee: <unix.aliases
+fred: frated@UCI.example
+b-people: Blind List: bill, betty
+Unix\-committee: <unix.aliases
 staff: =staff
 wheels: +wheel
-everyone: *
 news.*: news
-.in -.5i
 .fi
-
+.RE
+.PP
 The first line says that more aliases should immediately be read from
-the file \fI%etcdir%/BBoardAliases\fR.  Following this, \*(lqfred\*(rq
-is defined as an alias for \*(lqfrated@UCI\*(rq, and \*(lqsgroup\*(rq
-is defined as an alias for the three names \*(lqfrated@UCI\*(rq,
-\*(rqfear\*(rq, and \*(rqfreida\*(rq.
-.sp
+the file
+.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 delieved to those
-addresses, but the message header will  show only \*(lqBlind List: ;\*(rq
-(not the addresses).
-.sp
-Next, the definition of \*(lqUNIX\-committee\*(rq is given by
-reading the file \fIunix.aliases\fR in the users \fInmh\fR directory,
+\*(lqbill\*(rq and \*(lqbetty\*(rq; the message will be delivered to those
+addresses, but the message header will show only \*(lqBlind List: ;\*(rq
+(not the addresses).  The alias must not be terminated with, or contain,
+a semicolon.
+Note that blind lists are not supported with the
+.B sendmail/pipe
+mail transport method.
+.PP
+The definition of \*(lqUnix\-committee\*(rq is given by
+reading the file
+.I unix.aliases
+in the user's
+.B nmh
+directory.
+.PP
 \*(lqstaff\*(rq is defined as all users who are listed as members of the
-group \*(lqstaff\*(rq in the \fI/etc/group\fR file, and \*(lqwheels\*(rq
-is defined as all users whose group\-id in \fI/etc/passwd\fR is equivalent
-to the \*(lqwheel\*(rq group.
-.sp
-Finally, \*(lqeveryone\*(rq is defined as all users with a user\-id
-in \fI/etc/passwd\fR greater than 200, and all aliases of the form
-\*(lqnews.<anything>\*(rq are defined to be \*(lqnews\*(rq.
-
-The key thing to understand about aliasing in \fInmh\fR is that aliases
-in \fInmh\fR alias files are expanded into the headers of messages posted.
-This aliasing occurs first, at posting time, without the knowledge of the
-message transport system.  In contrast, once the message transport system
-is given a message to deliver to a list of addresses, for each address
-that appears to be local, a system\-wide alias file is consulted.  These
-aliases are \fBNOT\fR expanded into the headers of messages delivered.
-.Hh
-To use aliasing in \fInmh\fR quickly, do the following:
-
-.in +.5i
-First, in your \fI\&.mh\(ruprofile\fR, choose a name for your alias
-file, say \*(lqaliases\*(rq, and add the line:
-
-.nf
-.in +.5i
-Aliasfile: aliases
-.\" ali: \-alias aliases
-.\" send: \-alias aliases
-.\" whom: \-alias aliases
-.in -.5i
-.fi
-
-Second, create the file \*(lqaliases\*(rq in your \fInmh\fR directory.
-
-Third, start adding aliases to your \*(lqaliases\*(rq file as appropriate.
-.in -.5i
-.Fi
-^%etcdir%/MailAliases~^global nmh alias file
-.Pr
-^Aliasfile:~^For a default alias file
-.Sa
-ali(1), send(1), whom(1), group(5), passwd(5), conflict(8), post(8)
-.De
-None
-.Co
-None
-.Bu
-Although the forward-referencing semantics of \fImh\-alias\fR files
-prevent recursion, the \*(lq<\ alias\-file\*(rq command may defeat this.
-Since the number of file descriptors is finite (and very limited), such
+group \*(lqstaff\*(rq in the
+system's group database, and \*(lqwheels\*(rq
+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
+%nmhetcdir%/MailAliases
+System-wide default alias file.
+.SH "SEE ALSO"
+.IR ali (1),
+.IR send (1),
+.IR whom (1),
+.IR getgrent (3),
+.IR getpwent (3),
+.IR post (8)
+.SH BUGS
+Although the forward-referencing semantics of
+mh\-alias
+files prevent recursion, the
+.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
 all the fds are used up.
-.sp
-Forward references do not work correctly inside blind lists.
-.En
+.PP
+Earlier versions of this man page showed a semicolon at the end of the
+blind list example.  That caused the preceding alias to not be
+expanded.  There must not be a semicolon at the end of, or within, the
+address group of a blind list.
+.B post
+will append the semicolon to the blind list name.