Factor trim format function out
[mmh] / man / mh-mail.man5
index 05e825b..9d06dfc 100644 (file)
@@ -3,19 +3,15 @@
 .\"
 .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
-.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
-.B nmh
+.B mmh
 prefers,
-.B nmh
+.B mmh
 can read message files in that antiquated format.
 .PP
 Each user possesses a system maildrop box which initially receives all
@@ -24,20 +20,20 @@ messages delivered by the MTA.
 will read from that maildrop
 and incorporate the new messages found there into the user's own
 mail folders (typically
-.RI \*(lq +inbox \*(rq).
+.RI ` +inbox ').
 .PP
 Messages are expected to consist of lines of text.  Graphics and binary
 data are not directly handled.  No data compression is accepted.  All text is
 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
-.B nmh ,
+.B mmh ,
 the header and body may be separated by a line consisting of dashes:
 .PP
 .RS 5
@@ -58,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
-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
-specifications.  The rough format is \*(lqlocal@domain\*(rq, such as
-\*(lqbob@example.org\*(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
@@ -89,12 +85,12 @@ into the mail transport system.
 Added by
 .BR spost .
 Contains the address of the author or authors
-(may be more than one if a \*(lqSender:\*(rq field is present).  For a
+(may be more than one if a `Sender:' field is present).  For a
 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 :
@@ -103,20 +99,20 @@ For a 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.
+`Mail-Reply\-To:', `Reply\-To:', `From:',
+`Sender:'.
 .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
-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
@@ -126,8 +122,8 @@ For a 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.
+`Mail-Reply\-To:', `Reply\-To:', `From:',
+`Sender:'.
 .RE
 .PP
 .BR Sender :
@@ -135,7 +131,7 @@ constructed by checking the following headers (in this order):
 Added by
 .B spost
 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
@@ -151,7 +147,7 @@ Contains addresses of secondary recipients.
 .PP
 .BR Bcc :
 .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.
 .B mmh
@@ -207,24 +203,24 @@ New recipients for a message resent by
 .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
-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.
-See \*(lqFcc:\*(rq and \*(lqResent\-To:\*(rq.
+See `Fcc:' and `Resent\-To:'.
 .RE
 .PP
 .BR Resent\-Message\-Id :
 .RS 5
 A unique identifier glued on by the MTA.
-See \*(lqMessage\-Id:\*(rq and \*(lqResent\-To:\*(rq.
+See `Message\-Id:' and `Resent\-To:'.
 .RE
 .PP
 The following non-standard header components are also meaningful to