Factor trim format function out

[mmh] / man / mh-mail.man5

diff --git a/man/mh-mail.man5 b/man/mh-mail.man5
index 34d983c..9d06dfc 100644 (file)
--- a/man/mh-mail.man5
+++ b/man/mh-mail.man5
@@ -3,43 +3,37 @@
 .\"
 .TH MH-MAIL %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
 .\"
 .TH MH-MAIL %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME

-mh-mail \- message format for nmh message system
-.SH SYNOPSIS
-any
-.B nmh
-command
+mh-mail \- message format for mh message system

 .SH DESCRIPTION
 .SH DESCRIPTION

-.B nmh
+.B mmh

 processes messages in a particular format.  It should be noted
 that although neither Bell nor Berkeley mailers produce message files
 in the format that
 processes messages in a particular format.  It should be noted
 that although neither Bell nor Berkeley mailers produce message files
 in the format that

-.B nmh
+.B mmh

 prefers,
 prefers,

-.B nmh
+.B mmh

 can read message files in that antiquated format.
 .PP
 can read message files in that antiquated format.
 .PP

-Each user possesses a mail drop box which initially receives all messages
-processed by
-.BR post .
+Each user possesses a system maildrop box which initially receives all
+messages delivered by the MTA.

 .B Inc
 .B Inc

-will read from that drop
-box and incorporate the new messages found there into the user's own
+will read from that maildrop
+and incorporate the new messages found there into the user's own

 mail folders (typically
 mail folders (typically

-.RI \*(lq +inbox \*(rq).
-The mail drop box consists of one or more messages.
+.RI ` +inbox ').

 .PP
 Messages are expected to consist of lines of text.  Graphics and binary
 .PP
 Messages are expected to consist of lines of text.  Graphics and binary

-data are not handled.  No data compression is accepted.  All text is
+data are not directly handled.  No data compression is accepted.  All text is

 clear ASCII 7-bit data.
 .PP
 clear ASCII 7-bit data.
 .PP

-The general \*(lqmemo\*(rq framework of RFC\-822 is used.  A message
+The general `memo' framework of RFC\-822 is used.  A message

 consists of a block of information in a rigid format, followed by
 general text with no specified format.  The rigidly formatted first
 part of a message is called the header, and the free-format portion is
 called the body.  The header must always exist, but the body is optional.
 These parts are separated by an empty line, i.e., two consecutive newline
 characters.  Within
 consists of a block of information in a rigid format, followed by
 general text with no specified format.  The rigidly formatted first
 part of a message is called the header, and the free-format portion is
 called the body.  The header must always exist, but the body is optional.
 These parts are separated by an empty line, i.e., two consecutive newline
 characters.  Within

-.B nmh ,
+.B mmh ,

 the header and body may be separated by a line consisting of dashes:
 .PP
 .RS 5
 the header and body may be separated by a line consisting of dashes:
 .PP
 .RS 5

@@ -60,12 +54,12 @@ by RFC\-822), and is terminated by a colon (`:').  Certain components
 (as identified by their keywords) must follow rigidly defined formats
 in their text portions.
 .PP
 (as identified by their keywords) must follow rigidly defined formats
 in their text portions.
 .PP

-The text for most formatted components (e.g., \*(lqDate:\*(rq and
-\*(lqMessage\-Id:\*(rq) is produced automatically.  The only ones entered
-by the user are address fields such as \*(lqTo:\*(rq, \*(lqCc:\*(rq,
+The text for most formatted components (e.g., `Date:' and
+`Message\-Id:') is produced automatically.  The only ones entered
+by the user are address fields such as `To:', `Cc:',

 etc.  Internet addresses are assigned mailbox names and host computer
 etc.  Internet addresses are assigned mailbox names and host computer

-specifications.  The rough format is \*(lqlocal@domain\*(rq, such as
-\*(lqMH@UCI\*(rq, or \*(lqMH@UCI\-ICSA.ARPA\*(rq.  Multiple addresses
+specifications.  The rough format is `local@domain', such as
+`bob@example.org'.  Multiple addresses

 are separated by commas.  A missing host/domain is assumed to be the
 local host/domain.
 .PP
 are separated by commas.  A missing host/domain is assumed to be the
 local host/domain.
 .PP

@@ -75,28 +69,28 @@ expected or enforced within the body.
 .PP
 Following is a list of header components that are considered
 meaningful to various
 .PP
 Following is a list of header components that are considered
 meaningful to various

-.B nmh
+.B mmh

 programs.
 .PP
 .BR Date :
 .RS 5
 Added by
 programs.
 .PP
 .BR Date :
 .RS 5
 Added by

-.BR post ,
-contains date and time of the message's entry
+.BR spost .
+Contains date and time of the message's entry

 into the mail transport system.
 .RE
 .PP
 .BR From :
 .RS 5
 Added by
 into the mail transport system.
 .RE
 .PP
 .BR From :
 .RS 5
 Added by

-.BR post ,
-contains the address of the author or authors
-(may be more than one if a \*(lqSender:\*(rq field is present).  For a
+.BR spost .
+Contains the address of the author or authors
+(may be more than one if a `Sender:' field is present).  For a

 standard reply (using
 .BR repl ,
 the reply address is constructed by
 standard reply (using
 .BR repl ,
 the reply address is constructed by

-checking the following headers (in this order): \*(lqMail-Reply\-To:\*(rq,
-\*(lqReply\-To:\*(rq, \*(lqFrom:\*(rq, \*(lqSender:\*(rq.
+checking the following headers (in this order): `Mail-Reply\-To:',
+`Reply\-To:', `From:', `Sender:'.

 .RE
 .PP
 .BR Mail\-Reply\-To :
 .RE
 .PP
 .BR Mail\-Reply\-To :

@@ -105,20 +99,20 @@ For a standard reply (using
 .BR repl ),
 the reply address is
 constructed by checking the following headers (in this order):
 .BR repl ),
 the reply address is
 constructed by checking the following headers (in this order):

-\*(lqMail-Reply\-To:\*(rq, \*(lqReply\-To:\*(rq, \*(lqFrom:\*(rq,
-\*(lqSender:\*(rq.
+`Mail-Reply\-To:', `Reply\-To:', `From:',
+`Sender:'.

 .RE
 .PP
 .BR Mail\-Followup\-To :
 .RS 5
 .RE
 .PP
 .BR Mail\-Followup\-To :
 .RS 5

-When making a \*(lqgroup\*(rq reply (using
+When making a `group' reply (using

 .B repl
 .BR \-group ),
 any addresses in this field will take precedence, and no other reply address
 will be added to the draft.  If this header is not available, then the
 .B repl
 .BR \-group ),
 any addresses in this field will take precedence, and no other reply address
 will be added to the draft.  If this header is not available, then the

-return addresses will be constructed from the \*(lqMail-Reply\-To:\*(rq,
-or \*(lqReply\-To:\*(rq, or \*(lqFrom:\*(rq, along with adding the
-addresses from the headers \*(lqTo:\*(rq, \*(lqCc:\*(rq, as well as
+return addresses will be constructed from the `Mail-Reply\-To:',
+or `Reply\-To:', or `From:', along with adding the
+addresses from the headers `To:', `Cc:', as well as

 adding your personal address.
 .RE
 .PP
 adding your personal address.
 .RE
 .PP

@@ -128,16 +122,16 @@ For a standard reply (using
 .BR repl ),
 the reply address is
 constructed by checking the following headers (in this order):
 .BR repl ),
 the reply address is
 constructed by checking the following headers (in this order):

-\*(lqMail-Reply\-To:\*(rq, \*(lqReply\-To:\*(rq, \*(lqFrom:\*(rq,
-\*(lqSender:\*(rq.
+`Mail-Reply\-To:', `Reply\-To:', `From:',
+`Sender:'.

 .RE
 .PP
 .BR Sender :
 .RS 5
 Added by
 .RE
 .PP
 .BR Sender :
 .RS 5
 Added by

-.B post
+.B spost

 in the event that the message already has a
 in the event that the message already has a

-\*(lqFrom:\*(rq line.  This line contains the address of the actual
+`From:' line.  This line contains the address of the actual

 sender.
 .RE
 .PP
 sender.
 .RE
 .PP

@@ -146,36 +140,34 @@ sender.
 Contains addresses of primary recipients.
 .RE
 .PP
 Contains addresses of primary recipients.
 .RE
 .PP

-.BR cc :
+.BR Cc :

 .RS 5
 Contains addresses of secondary recipients.
 .RE
 .PP
 .RS 5
 Contains addresses of secondary recipients.
 .RE
 .PP

-Bcc:
+.BR Bcc :

 .RS 5
 .RS 5

-Still more recipients.  However, the \*(lqBcc:\*(rq line is not
+Still more recipients.  However, the `Bcc:' line is not

 copied onto the message as delivered, so these recipients are not
 listed.
 copied onto the message as delivered, so these recipients are not
 listed.

-.B nmh
+.B mmh

 uses an encapsulation method for blind copies, see
 uses an encapsulation method for blind copies, see

-.BR send .
+.BR send (1)
+or
+.BR spost (8).

 .RE
 .PP
 .BR Fcc :
 .RS 5
 Causes
 .RE
 .PP
 .BR Fcc :
 .RS 5
 Causes

-.B post
+.B spost

 to copy the message into the specified folder for the sender,
 if the message was successfully given to the transport system.
 .RE
 .PP
 .BR Message\-ID :
 .RS 5
 to copy the message into the specified folder for the sender,
 if the message was successfully given to the transport system.
 .RE
 .PP
 .BR Message\-ID :
 .RS 5

-A unique message identifier added by
-.B post
-if the
-.B \-msgid
-flag is set.
+A unique message identifier added by the MTA.

 .RE
 .PP
 .BR Subject :
 .RE
 .PP
 .BR Subject :

@@ -194,13 +186,13 @@ when replying to a message.
 .BR Resent\-Date :
 .RS 5
 Added when redistributing a message by
 .BR Resent\-Date :
 .RS 5
 Added when redistributing a message by

-.BR post .
+.BR spost .

 .RE
 .PP
 .BR Resent\-From :
 .RS 5
 Added when redistributing a message by
 .RE
 .PP
 .BR Resent\-From :
 .RS 5
 Added when redistributing a message by

-.BR post .
+.BR spost .

 .RE
 .PP
 .BR Resent\-To:
 .RE
 .PP
 .BR Resent\-To:

@@ -211,34 +203,41 @@ New recipients for a message resent by
 .PP
 .BR Resent\-Cc :
 .RS 5
 .PP
 .BR Resent\-Cc :
 .RS 5

-Still more recipients. See \*(lqCc:\*(rq and \*(lqResent\-To:\*(rq.
+Still more recipients. See `Cc:' and `Resent\-To:'.

 .RE
 .PP
 .BR Resent\-Bcc :
 .RS 5
 .RE
 .PP
 .BR Resent\-Bcc :
 .RS 5

-Even more recipients. See \*(lqBcc:\*(rq and \*(lqResent\-To:\*(rq.
+Even more recipients. See `Bcc:' and `Resent\-To:'.

 .RE
 .PP
 .BR Resent\-Fcc :
 .RS 5
 Copy resent message into a folder.
 .RE
 .PP
 .BR Resent\-Fcc :
 .RS 5
 Copy resent message into a folder.

-See \*(lqFcc:\*(rq and \*(lqResent\-To:\*(rq.
+See `Fcc:' and `Resent\-To:'.

 .RE
 .PP
 .BR Resent\-Message\-Id :
 .RS 5
 .RE
 .PP
 .BR Resent\-Message\-Id :
 .RS 5

-A unique identifier glued on by
-.B post
-if the
-.B \-msgid
-flag is set.
-See \*(lqMessage\-Id:\*(rq and \*(lqResent\-To:\*(rq.
+A unique identifier glued on by the MTA.
+See `Message\-Id:' and `Resent\-To:'.

 .RE
 .PP
 .RE
 .PP

-.BR Resent :
+The following non-standard header components are also meaningful to
+.B mmh
+tools:
+.PP
+.BR Attach :

 .RS 5
 Annotation for
 .RS 5
 Annotation for

-.B dist
+.B send
+to attach the given file to the message being sent.
+.RE
+.PP
+.BR Replied :
+.RS 5
+Annotation for
+.B repl

 under the
 .B \-annotate
 option.
 under the
 .B \-annotate
 option.

@@ -253,10 +252,10 @@ under the
 option.
 .RE
 .PP
 option.
 .RE
 .PP

-.BR Replied :
+.BR Resent :

 .RS 5
 Annotation for
 .RS 5
 Annotation for

-.B repl
+.B dist

 under the
 .B \-annotate
 option.
 under the
 .B \-annotate
 option.