Fixed number of bytes to fread() in strip_crs() in mhfixmsg.

[nmh] / man / mh-alias.man

diff --git a/man/mh-alias.man b/man/mh-alias.man
index 451ea63b33f0f555d8b1a9fee11349432f392984..ca9e0a2c203531f090ad64640f9c0989de575430 100644 (file)
--- a/man/mh-alias.man
+++ b/man/mh-alias.man
@@ -1,198 +1,282 @@
+.TH MH-ALIAS %manext5% "Oct 14, 2012" "%nmhversion%"

 .\"
 .\" %nmhwarning%
 .\"
 .\" %nmhwarning%

-.\" $Id$

 .\"
 .\"

-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
-.TH MH-ALIAS %manext5% MH.6.8 [%nmhversion%]

 .SH NAME
 mh-alias \- alias file for nmh message system
 .SH SYNOPSIS
 .SH NAME
 mh-alias \- alias file for nmh message system
 .SH SYNOPSIS

-.in +.5i
-.ti -.5i
-any \fInmh\fR command
-.in -.5i
+any
+.B nmh
+command

 .SH DESCRIPTION
 .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.
+This describes both
+.B nmh
+personal alias files and
+the global alias file for
+.B nmh
+mail delivery, the file
+.PP
+.RS 5
+%etcdir%/MailAliases
+.RE
+.PP
+It does
+.B not
+describe aliases files used by the message transport system.

 Each line of the alias file has the format:
 Each line of the alias file has the format:

-
-       alias : address\-group
-.br
+.PP
+.RS 5
+.I alias
+.B :
+.I address\-group
+.RE

 or
 or

-.br
-       alias ; address\-group
-.br
+.RS 5
+.I alias
+.B ;
+.I address\-group
+.RE

 or
 or

-.br
-       < alias\-file
-.br
+.RS 5
+.B <
+.I alias\-file
+.RE

 or
 or

-.br
-       ; comment
-.br
-
+.RS 5
+.B ;
+|
+.B :
+|
+.B #
+.I comment
+.RE
+.PP

 where:
 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
-
+.IR address\-list "    := " address
+.RI "                  |  " address\-list ", " address
+.fi
+.RE
+.PP

 Continuation lines in alias files end with `\\' followed by the newline
 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
+character.  This applies to comment lines.  Thus, a line following a
+comment line that ends with a `\\' will be treated as a continuation of
+the comment.
+.PP
+.RI \*(lq  Alias\-file \*(rq
+and
+.RI \*(lq file \*(rq
+are UNIX file names.
+.I UNIX\-group
+is a group name (or number) from
+.IR /etc/group .
+An address is a \*(lqsimple\*(rq

 Internet\-style address.  Througout this file, case is ignored, except
 Internet\-style address.  Througout this file, case is ignored, except

-for alias\-file names.
-
+for file names.
+.PP

 If the line starts with a `<', then the file named after the `<' 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 line starts with a `<', then the file named after the `<' 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
+.PP
+If the
+.I address\-group
+starts with a `<', then the file named after the
+`<' is read and its contents are added to the
+.I address\-list
+for the alias.
+.PP
+If the
+.I address\-group
+starts with an `=', then the file
+.I /etc/group

 is consulted for the UNIX\-group named after the `='.  Each login name
 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
+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 `+', then the file
+.I /etc/group
+is consulted to determine the group\-id of the

 UNIX\-group named after the `+'.  Each login name occurring in 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
+.I /etc/passwd
+file whose group\-id is indicated by this group is
+added to the
+.I address\-list
+for the alias.
+.PP
+If the
+.I address\-group
+is simply `*', then the file
+.I /etc/passwd
+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.
+.PP
+In match, a trailing \*(lq*\*(rq on an alias will match just about anything

 appropriate.  (See example below.)
 appropriate.  (See example below.)

-
+.PP

 An approximation of the way aliases are resolved at posting time is
 (it's not really done this way):
 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,
+.IP 1)
+Build a list of all addresses from the message to be delivered,

 eliminating duplicate addresses.
 eliminating duplicate addresses.

-
-2) If this draft originated on the local host, then for those addresses in
+.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.
 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 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
 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
 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
 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
-
+correct format (with the alias quoted if necessary and the address
+wrapped in <>).
+.PP
+This makes replies possible since
+.B nmh
+aliases
+and personal aliases are unknown to the mail transport system.
+.PP

 Since the alias file is read line by line, forward references work, but
 backward references are not recognized, thus, there is no recursion.
 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
+.PP
+Example Alias File:
+.PP
+.RS 5

 .nf
 .nf

-.in +.5i

 <%etcdir%/BBoardAliases
 sgroup: fred, fear, freida
 <%etcdir%/BBoardAliases
 sgroup: fred, fear, freida

-b-people: Blind List: bill, betty;
+b-people: Blind List: bill, betty

 fred: frated@UCI
 UNIX\-committee: <unix.aliases
 staff: =staff
 wheels: +wheel
 everyone: *
 news.*: news
 fred: frated@UCI
 UNIX\-committee: <unix.aliases
 staff: =staff
 wheels: +wheel
 everyone: *
 news.*: news

-.in -.5i

 .fi
 .fi

-
+.RE
+.PP

 The first line says that more aliases should immediately be read from
 The first line says that more aliases should immediately be read from

-the file \fI%etcdir%/BBoardAliases\fR.  Following this, \*(lqfred\*(rq
+the file
+.IR %etcdir%/BBoardAliases .
+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.
 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
+.PP

 The alias \*(lqb-people\*(rq is a blind list which includes the addresses
 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
+\*(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; see
+.B Helpful Hints
+below.  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
 Next, the definition of \*(lqUNIX\-committee\*(rq is given by

-reading the file \fIunix.aliases\fR in the users \fInmh\fR directory,
+reading the file
+.I unix.aliases
+in the users
+.B nmh
+directory,

 \*(lqstaff\*(rq is defined as all users who are listed as members of the
 \*(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
+group \*(lqstaff\*(rq in the
+.I /etc/group
+file, and \*(lqwheels\*(rq
+is defined as all users whose group\-id in
+.I /etc/passwd
+is equivalent to the \*(lqwheel\*(rq group.
+.PP

 Finally, \*(lqeveryone\*(rq is defined as all users with a user\-id
 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
+in
+.I /etc/passwd
+greater than 200, and all aliases of the form

 \*(lqnews.<anything>\*(rq are defined to be \*(lqnews\*(rq.
 \*(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.
+.PP
+The key thing to understand about aliasing in
+.B nmh
+is that aliases in
+.B nmh
+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
 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
+aliases are
+.B not
+expanded into the headers of messages delivered.
+.SH "HELPFUL HINTS"
+To use aliasing in
+.B nmh
+quickly, do the following:
+.IP 1)
+In your
+.IR \&.mh\(ruprofile ,
+choose a name for your alias file, say
+.RI \*(lq aliases \*(rq,
+and add the line:
+.sp

 Aliasfile: aliases
 .\" ali: \-alias aliases
 .\" send: \-alias aliases
 .\" whom: \-alias aliases
 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
+.RE
+.IP 2)
+Create the file
+.RI \*(lq aliases \*(rq
+in your
+.B nmh
+directory.
+.IP 3)
+Start adding aliases to your
+.RI \*(lq aliases \*(rq
+file as appropriate.
+.RE
+.PP
+Earlier versions of this man page showed a semicolon at the end of the
+blind list example.  That caused the preceeding 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.
+.SH FILES
+.TP 20
+%etcdir%/MailAliases
+global nmh alias file
+.SH "PROFILE COMPONENTS"
+.TP 20
+Aliasfile:
+Default alias file
+.SH "SEE ALSO"
+.IR ali (1),
+.IR send (1),
+.IR whom (1),
+.IR group (5),
+.IR passwd (5),
+.IR conflict (8),
+.IR post (8)
+.SH CONTEXT

 None
 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.
+.SH BUGS
+Although the forward-referencing semantics of
+.B mh\-alias
+files prevent recursion, the
+.RI \*(lq< " alias\-file" \*(rq
+command may defeat this.

 Since the number of file descriptors is finite (and very limited), such
 infinite recursion will terminate with a meaningless diagnostic when
 all the fds are used up.
 Since the number of file descriptors is finite (and very limited), 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