Added warning about when post(1) can't refile(1) a draft.

[nmh] / man / comp.man

diff --git a/man/comp.man b/man/comp.man
index 0fddc260b595fd4962484f9f2ba8a6559098281e..0b3fb0aeffc46959605792ab399fcdee00b6200d 100644 (file)
--- a/man/comp.man
+++ b/man/comp.man
@@ -1,15 +1,17 @@
-.\"
+.TH COMP %manext1% 2013-10-18 "%nmhversion%"
+.

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

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

 .SH NAME
 .SH NAME

-comp \- compose a message
+comp \- compose an nmh message

 .SH SYNOPSIS
 .HP 5
 .na
 .SH SYNOPSIS
 .HP 5
 .na

-.B comp 
+.B comp
+.RB [ \-help ]
+.RB [ \-version ]

 .RI [ +folder ]
 .RI [ +folder ]

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

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


@@ -38,11 +40,10 @@ comp \- compose a message
 .RB [ \-whatnowproc
 .IR program ]
 .RB [ \-nowhatnowproc ]
 .RB [ \-whatnowproc
 .IR program ]
 .RB [ \-nowhatnowproc ]

-.RB [ \-version ]
-.RB [ \-help ]
+.RB [ \-build ]

 .ad
 .SH DESCRIPTION
 .ad
 .SH DESCRIPTION

-.B Comp
+.B comp

 is used to create a new message to be mailed.  It copies a
 message form to the draft being composed and then invokes an editor on
 the draft (unless
 is used to create a new message to be mailed.  It copies a
 message form to the draft being composed and then invokes an editor on
 the draft (unless


@@ -91,7 +92,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


@@ -119,17 +120,19 @@ Forms that are selected via the
 .B \-form
 switch are processed via the
 .B nmh
 .B \-form
 switch are processed via the
 .B nmh

-template system; see 
-.BR mh\-format (5)
+template system; see
+.IR mh\-format (5)

 for details.  Drafts constructed from another message or with the
 .B \-use
 or
 .B \-file
 for details.  Drafts constructed from another message or with the
 .B \-use
 or
 .B \-file

-switchs will NOT be processed with
-.BR mh\-format (5).
+switches will
+.I not
+be processed with
+.IR mh\-format (5).

 .PP
 In addition to the standard
 .PP
 In addition to the standard

-.BR mh\-format (5)
+.IR mh\-format (5)

 escapes,
 the following
 .I component
 escapes,
 the following
 .I component


@@ -138,7 +141,7 @@ escapes are either new or have an alternate meaning:
 .RS 5
 .nf
 .ta \w'Escape  'u +\w'Returns  'u
 .RS 5
 .nf
 .ta \w'Escape  'u +\w'Returns  'u

-.I Escape      Returns Description
+.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'
 fcc    string  Any folders specified with `\-fcc\ folder'
 from   string  Any addresses specified with `\-from\ address'
 to     string  Any addresses specified with `\-to\ address'


@@ -164,7 +167,7 @@ overridden by using the
 .B \-from
 .I address
 switch.  The default mailbox in the \*(lqFcc:\*(rq field is
 .B \-from
 .I address
 switch.  The default mailbox in the \*(lqFcc:\*(rq field is

-.IR \+outbox .
+.IR +outbox .

 This can be overridden by the
 .B \-fcc
 switch.
 This can be overridden by the
 .B \-fcc
 switch.


@@ -207,7 +210,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


@@ -218,56 +221,82 @@ initial edit.  Upon exiting from the editor,
 .B comp
 will invoke the
 .B whatnow
 .B comp
 will invoke the
 .B whatnow

-program.  See
-.BR whatnow (1)
+program (see
+.IR whatnow (1)

 for a discussion of
 for a discussion of

-available options.  The invocation of this program can be inhibited
+available options).  The invocation of this program can be inhibited

 by using the
 .B \-nowhatnowproc
 by using the
 .B \-nowhatnowproc

-switch.  (In truth of fact, it is
-the
+switch.  (In fact, it is the

 .I whatnow
 program which starts the initial edit.  Hence,
 .B \-nowhatnowproc
 will prevent any edit from occurring.)
 .I whatnow
 program which starts the initial edit.  Hence,
 .B \-nowhatnowproc
 will prevent any edit from occurring.)

-
+.PP
+The
+.B \-build
+switch is intended to be used by the Emacs mh-e interface to
+.BR nmh .
+It implies
+.BR \-nowhatnowproc .
+It causes a file <mh-dir>/draft to be created, containing the draft message that
+would normally be presented to the user for editing.
+No mail is actually sent.

 .SH FILES
 .SH FILES

-.fc ^ ~
-.nf
-.ta \w'%etcdir%/ExtraBigFileName  'u
-^%etcdir%/components~^The standard message skeleton
-^or <mh\-dir>/components~^Rather than the standard skeleton
-^$HOME/\&.mh\(ruprofile~^The user profile
-^<mh\-dir>/draft~^The draft file
-.fi
-
+.PD 0
+.TP 20
+%nmhetcdir%/components
+The default message skeleton.
+.TP
+<mh-dir>/components
+The user's message skeleton.
+.TP
+$HOME/.mh_profile
+The user's profile.
+.PD

 .SH "PROFILE COMPONENTS"
 .SH "PROFILE COMPONENTS"

-.fc ^ ~
-.nf
-.ta 2.4i
-.ta \w'ExtraBigProfileName  'u
-^Path:~^To determine the user's nmh directory
-^Draft\-Folder:~^To find the default draft\-folder
-^Editor:~^To override the default editor
-^Msg\-Protect:~^To set mode when creating a new message (draft)
-^fileproc:~^Program to refile the message
-^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
-.fi
-
+.PD 0
+.TP 20
+Path:
+To determine the user's nmh directory.
+.TP
+Draft\-Folder:
+To find the default draft-folder.
+.TP
+Editor:
+To override the default editor.
+.TP
+Msg\-Protect:
+To set mode when creating a new message (draft).
+.TP
+fileproc:
+Program to refile the message.
+.TP
+whatnowproc:
+Program to ask the \*(lqWhat now?\*(rq questions
+.PD

 .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
 .SH DEFAULTS

-.nf
-.RB ` +folder "' defaults to the current folder"
-.RB ` msg "' defaults to the current message"
-.RB ` \-nodraftfolder '
-.RB ` \-nouse '
-.fi
-
+.PD 0
+.TP 20
++folder
+The current folder.
+.TP
+msg
+The current message.
+.TP
+\-nodraftfolder
+.TP
+\-nouse
+.PD

 .SH CONTEXT
 None
 .SH CONTEXT
 None

-

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


@@ -275,7 +304,7 @@ is
 .BR whatnow ,
 then
 .B comp
 .BR whatnow ,
 then
 .B comp

-uses a built\-in
+uses a built-in

 .BR whatnow ,
 it does not actually run the
 .B whatnow
 .BR whatnow ,
 it does not actually run the
 .B whatnow