Fix to 25581a94c5113eb78b2baf7110408df96efc4418: always set $editalt,

[mmh] / man / comp.man

diff --git a/man/comp.man b/man/comp.man
index 643c056..bd0a762 100644 (file)
--- a/man/comp.man
+++ b/man/comp.man
@@ -1,7 +1,7 @@
+.TH COMP %manext1% "May 21, 2012" "%nmhversion%"

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

-.TH COMP %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]

 .SH NAME
 comp \- compose a message
 .SH SYNOPSIS
 .SH NAME
 comp \- compose a message
 .SH SYNOPSIS

@@ -9,7 +9,7 @@ comp \- compose a message
 .na
 .B comp 
 .RI [ +folder ]
 .na
 .B comp 
 .RI [ +folder ]

-.RI [ msgs ]
+.RI [ msg ]

 .RB [ \-form
 .IR formfile ]
 .RB [ \-use " | " \-nouse ]
 .RB [ \-form
 .IR formfile ]
 .RB [ \-use " | " \-nouse ]

@@ -23,6 +23,18 @@ comp \- compose a message
 .RB [ \-editor
 .IR editor ]
 .RB [ \-noedit ]
 .RB [ \-editor
 .IR editor ]
 .RB [ \-noedit ]

+.RB [ \-width
+.IR columns ]
+.RB [ \-from
+.IR address ]
+.RB [ \-to
+.IR address ]
+.RB [ \-cc
+.IR address ]
+.RB [ \-fcc
+.IR +folder ]
+.RB [ \-subject
+.IR text ]

 .RB [ \-whatnowproc
 .IR program ]
 .RB [ \-nowhatnowproc ]
 .RB [ \-whatnowproc
 .IR program ]
 .RB [ \-nowhatnowproc ]

@@ -37,11 +49,18 @@ the draft (unless
 .B \-noedit
 is given, in which case the initial edit is suppressed).
 .PP
 .B \-noedit
 is given, in which case the initial edit is suppressed).
 .PP

-The default message form contains the following elements:
+The default message template \*(lqcomponents\*(rq will direct
+.B comp
+to construct the message draft as follows:

 .PP
 .RS 5
 .nf
 .PP
 .RS 5
 .nf

-%components%
+From: {from switch} or <Local-Mailbox> or <username@hostname>
+To: {to switch} or blank
+cc: {cc switch} or blank
+Fcc: {fcc switch} or +outbox
+Subject: {subject switch} or blank
+--------

 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

@@ -72,7 +91,7 @@ argument.  The line of
 dashes or a blank line must be left between the header and the body of
 the message for the message to be identified properly when it is sent
 (see
 dashes or a blank line must be left between the header and the body of
 the message for the message to be identified properly when it is sent
 (see

-.BR send (1)).
+.IR send (1)).

 .PP
 The switch
 .B \-use
 .PP
 The switch
 .B \-use

@@ -98,14 +117,61 @@ switch says to use the named file as the message draft.
 .PP
 Forms that are selected via the
 .B \-form
 .PP
 Forms that are selected via the
 .B \-form

-switch are processed via the mh template system; see 
-.BR mh\-format (5)
-for details.  Drafts constructed from another mssage or with the
+switch are processed via the
+.B nmh
+template system; see 
+.IR mh\-format (5)
+for details.  Drafts constructed from another message or with the

 .B \-use
 or
 .B \-file
 switchs will NOT be processed with
 .B \-use
 or
 .B \-file
 switchs will NOT be processed with

-.BR mh\-format (5).
+.IR mh\-format (5).
+.PP
+In addition to the standard
+.IR mh\-format (5)
+escapes,
+the following
+.I component
+escapes are either new or have an alternate meaning:
+.PP
+.RS 5
+.nf
+.ta \w'Escape  'u +\w'Returns  'u
+.I "Escape     Returns Description"
+fcc    string  Any folders specified with `\-fcc\ folder'
+from   string  Any addresses specified with `\-from\ address'
+to     string  Any addresses specified with `\-to\ address'
+cc     string  Any addresses specified with `\-cc\ address'
+subject        string  Any text specified with `\-subject\ text'
+.fi
+.RE
+.PP
+By default the \*(lqTo:\*(rq and \*(lqcc:\*(rq fields are empty.  You may
+add addresses to these fields with the
+.B \-to
+.I address
+and
+.B \-cc
+.I address
+switches.  You may give these switches multiple times to add multiple
+addresses.
+.PP
+By default the \*(lqFrom:\*(rq field has either the value of the
+.B Local\-Mailbox
+profile entry or a system default email address.  This default can be
+overridden by using the
+.B \-from
+.I address
+switch.  The default mailbox in the \*(lqFcc:\*(rq field is
+.IR +outbox .
+This can be overridden by the
+.B \-fcc
+switch.
+.PP
+Any text you give to the
+.B \-subject
+switch will be placed in the \*(lqSubject:\*(rq field in the draft.

 .PP
 If the draft already exists,
 .B comp
 .PP
 If the draft already exists,
 .B comp

@@ -141,7 +207,7 @@ switches invoke the
 .B nmh
 draft folder facility.  This is an advanced (and highly
 useful) feature.  Consult the
 .B nmh
 draft folder facility.  This is an advanced (and highly
 useful) feature.  Consult the

-.BR mh-draft (5)
+.IR mh-draft (5)

 man page for more information.
 .PP
 The
 man page for more information.
 .PP
 The

@@ -153,7 +219,7 @@ initial edit.  Upon exiting from the editor,
 will invoke the
 .B whatnow
 program.  See
 will invoke the
 .B whatnow
 program.  See

-.BR whatnow (1)
+.IR whatnow (1)

 for a discussion of
 available options.  The invocation of this program can be inhibited
 by using the
 for a discussion of
 available options.  The invocation of this program can be inhibited
 by using the

@@ -164,7 +230,6 @@ the
 program which starts the initial edit.  Hence,
 .B \-nowhatnowproc
 will prevent any edit from occurring.)
 program which starts the initial edit.  Hence,
 .B \-nowhatnowproc
 will prevent any edit from occurring.)

-

 .SH FILES
 .fc ^ ~
 .nf
 .SH FILES
 .fc ^ ~
 .nf

@@ -174,7 +239,6 @@ will prevent any edit from occurring.)
 ^$HOME/\&.mh\(ruprofile~^The user profile
 ^<mh\-dir>/draft~^The draft file
 .fi
 ^$HOME/\&.mh\(ruprofile~^The user profile
 ^<mh\-dir>/draft~^The draft file
 .fi

-

 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf

@@ -187,10 +251,13 @@ will prevent any edit from occurring.)
 ^fileproc:~^Program to refile the message
 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
 .fi
 ^fileproc:~^Program to refile the message
 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
 .fi

-

 .SH "SEE ALSO"
 .SH "SEE ALSO"

-dist(1), forw(1), repl(1), send(1), whatnow(1), mh-profile(5)
-
+.IR dist (1),
+.IR forw (1),
+.IR repl (1),
+.IR send (1),
+.IR whatnow (1),
+.IR mh-profile (5)

 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"

@@ -198,10 +265,8 @@ dist(1), forw(1), repl(1), send(1), whatnow(1), mh-profile(5)
 .RB ` \-nodraftfolder '
 .RB ` \-nouse '
 .fi
 .RB ` \-nodraftfolder '
 .RB ` \-nouse '
 .fi

-

 .SH CONTEXT
 None
 .SH CONTEXT
 None

-

 .SH BUGS
 If
 .I whatnowproc
 .SH BUGS
 If
 .I whatnowproc