Added context_find_prefix().

[nmh] / man / mh-mail.man

diff --git a/man/mh-mail.man b/man/mh-mail.man
index 73f2e836a40c031582c7bc5895f2433c484878d6..6f481ca8acc1d91ca2a8bd3e109c66af49eb5a6c 100644 (file)
--- a/man/mh-mail.man
+++ b/man/mh-mail.man
@@ -1,14 +1,9 @@
+.TH MH-MAIL %manext5% "January 8, 2014" "%nmhversion%"
 .\"
 .\" %nmhwarning%
-.\" $Id$
 .\"
-.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
 .SH DESCRIPTION
 .B nmh
 processes messages in a particular format.  It should be noted
@@ -33,19 +28,23 @@ Messages are expected to consist of lines of text.  Graphics and binary
 data are not 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 \*(lqmemo\*(rq 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 ,
+.BR nmh ,
 the header and body may be separated by a line consisting of dashes:
 .PP
 .RS 5
 .nf
-%components%
+From: Local Mailbox <user@example.com>
+To:
+cc:
+Fcc: +outbox
+Subject:
 .fi
 .RE
 .PP
@@ -57,7 +56,7 @@ are indicated by leading spaces or tabs.
 Each header item is called a component and is composed of a keyword or
 name, along with associated text.  The keyword begins at the left margin,
 may NOT contain spaces or tabs, may not exceed 63 characters (as specified
-by RFC\-822), and is terminated by a colon (`:').  Certain components
+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
@@ -89,15 +88,34 @@ into the mail transport system.
 .PP
 .BR From :
 .RS 5
-Added by
-.BR post ,
+This header is filled in by default with the system's idea of the user's local
+mailbox.  This can be changed with the
+.B Local\-Mailbox
+profile entry.  It
 contains the address of the author or authors
 (may be more than one if a \*(lqSender:\*(rq field is present).  For a
 standard reply (using
-.BR repl ,
+.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.
+A \*(lqFrom:\*(rq
+header MUST exist when the message is sent to
+.BR post,
+otherwise the message will be rejected.
+.RE
+.PP
+.BR Envelope\-From :
+.RS 5
+Used by
+.B post
+to specify a value for the sender's envelope address to the mail transport
+system.  If omitted, 
+.B post
+will use the value of the \*(lqSender:\*(rq or the \*(lqFrom:\*(rq header.
+See
+.IR send (1)
+for more details.
 .RE
 .PP
 .BR Mail\-Reply\-To :
@@ -135,10 +153,11 @@ constructed by checking the following headers (in this order):
 .PP
 .BR Sender :
 .RS 5
-Added by
+Required by
 .B post
-in the event that the message already has a
-\*(lqFrom:\*(rq line.  This line contains the address of the actual
+in the event that the message has multiple addresses on the
+\*(lqFrom:\*(rq line.  It is otherwise optional.  This line should
+contain the address of the actual
 sender.
 .RE
 .PP
@@ -152,14 +171,28 @@ Contains addresses of primary recipients.
 Contains addresses of secondary recipients.
 .RE
 .PP
-Bcc:
+.BR Bcc :
 .RS 5
 Still more recipients.  However, the \*(lqBcc:\*(rq line is not
 copied onto the message as delivered, so these recipients are not
 listed.
 .B nmh
 uses an encapsulation method for blind copies, see
-.BR send .
+.IR send (1).
+.RE
+.PP
+.BR Dcc :
+.RS 5
+Still more recipients.  However, the \*(lqDcc:\*(rq line is not
+copied onto the messages as delivered.  Recipients on the \*(lqDcc:\*(rq
+line receive the same message as recipients on the \*(lqTo:\*(rq and
+\*(lqcc:\*(rq lines.  See
+.IR send (1)
+for more details.
+.B Dcc
+is not supported with the
+.B sendmail/pipe
+mail transport method.
 .RE
 .PP
 .BR Fcc :
@@ -200,8 +233,10 @@ Added when redistributing a message by
 .PP
 .BR Resent\-From :
 .RS 5
-Added when redistributing a message by
-.BR post .
+Used instead of the \*(lqFrom:\*(rq header when
+.B post 
+redistributes a message.  See \*(lqFrom:\*(rq for more information about
+this header is used.
 .RE
 .PP
 .BR Resent\-To:
@@ -262,17 +297,22 @@ under the
 .B \-annotate
 option.
 .RE
-
+.PP
+.BR Attach :
+.RS 5
+Used by
+.B mhbuild
+to specify a filename to attach to this message.  See
+.IR mhbuild (1)
+for more information.
+.RE
 .SH FILES
-.fc ^ ~
-.nf
-.ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
-^%mailspool%/$USER~^Location of mail drop
-.fi
-
+.TP 20
+%mailspool%/$USER
+Location of mail drop.
 .SH "SEE ALSO"
-.I "Standard for the Format of ARPA Internet Text Messages
-(RFC\-822)
-
+.I
+Standard for the Format of ARPA Internet Text Messages
+(RFC 822)
 .SH CONTEXT
 None