repl.c, replsbr.c: Move shared data into header file.

[nmh] / man / mh-draft.man

diff --git a/man/mh-draft.man b/man/mh-draft.man
index 63b7b0df4d747096896ddbe21d5902b9bec3a56d..2ba6f2a80337fa6fb3170e495f3d086ab39e6273 100644 (file)
--- a/man/mh-draft.man
+++ b/man/mh-draft.man
@@ -1,54 +1,44 @@
-.\"
+.TH MH-DRAFT %manext5% 2012-03-18 "%nmhversion%"
+.

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

-.\"
-.TH MH-DRAFT %manext5% "%nmhdate%" MH.6.8 [%nmhversion%]
+.

 .SH NAME
 mh-draft \- draft folder facility for nmh message system
 .SH NAME
 mh-draft \- draft folder facility for nmh message system

-.SH SYNOPSIS
-any
-.B nmh
-command

 .SH DESCRIPTION
 There are a number of interesting advanced facilities for the composition of
 outgoing mail.
 .SH DESCRIPTION
 There are a number of interesting advanced facilities for the composition of
 outgoing mail.

-.PP

 .SS "The Draft Folder"
 The
 .BR comp ,
 .BR dist ,
 .BR forw ,
 .SS "The Draft Folder"
 The
 .BR comp ,
 .BR dist ,
 .BR forw ,

+.BR repl ,
+.BR send ,

 and
 and

-.B repl
-commands have two additional switches,
+.B whom
+commands each take the switches

 .B \-draftfolder
 .I +folder
 and
 .B \-draftmessage
 .B \-draftfolder
 .I +folder
 and
 .B \-draftmessage

-.I msg
+.IR msg ,

 which allow you to manipulate the various draft messages you are composing.
 .PP
 If
 .B \-draftfolder
 .I +folder
 which allow you to manipulate the various draft messages you are composing.
 .PP
 If
 .B \-draftfolder
 .I +folder

-is used, these commands are
-directed to construct a draft message in the indicated folder.
-(The
+is used, draft messages will be constructed in the indicated folder.  The

 .RI \*(lq Draft\-Folder \*(rq
 .RI \*(lq Draft\-Folder \*(rq

-profile entry may be used to declare a default draft folder for use with
-.BR comp ,
-.BR dist ,
-.BR forw ,
-and
-.BR repl ).
+profile entry may be used to specify a default draft folder.

 .PP
 .PP

-If the swith
+If the switch

 .B \-draftmessage
 .I msg
 is given, the specified draft is used to compose the message.  If
 .B \-draftmessage
 .I msg
 .B \-draftmessage
 .I msg
 is given, the specified draft is used to compose the message.  If
 .B \-draftmessage
 .I msg

-is not used, then the
-draft defaults to `new' (create a new draft) unless the user invokes
+is not used, then the draft defaults to `new' (create a new draft)
+unless the user invokes

 .B comp
 with
 .BR \-use ,
 .B comp
 with
 .BR \-use ,


@@ -64,26 +54,24 @@ tools are available on each of the user's message drafts (e.g.
 and so on).  If the folder does not exist, the user is asked if it should be
 created (just like with
 .BR refile ).
 and so on).  If the folder does not exist, the user is asked if it should be
 created (just like with
 .BR refile ).

-Also, the last draft message
-the user was composing is known as `cur' in the draft folder.
+The last draft message the user was composing is known as `cur'
+in the draft folder.

 .PP
 .PP

-Furthermore, the
-.B send
-command has these switches as well.  Hence,
-from the shell, the user can send off whatever drafts desired using the
-standard
+Using
+.BR send ,
+the user can send drafts using the standard

 .B nmh
 `msgs' convention with
 .B \-draftmessage
 .IR msgs .
 If no `msgs' are given, it defaults to `cur'.
 .PP
 .B nmh
 `msgs' convention with
 .B \-draftmessage
 .IR msgs .
 If no `msgs' are given, it defaults to `cur'.
 .PP

-In addition, all five programs have a
+In addition, all of these programs have a

 .B \-nodraftfolder
 switch, which undoes the last occurrence of
 .B \-draftfolder
 .I folder
 .B \-nodraftfolder
 switch, which undoes the last occurrence of
 .B \-draftfolder
 .I folder

-(useful if the latter occurs in the user's
+(useful if a default is specified in the user's

 .B nmh
 profile).
 .PP
 .B nmh
 profile).
 .PP


@@ -104,12 +92,12 @@ or
 .BR send ,
 the user needn't prefix the draft `msg' or `msgs' with
 .BR \-draftmessage .
 .BR send ,
 the user needn't prefix the draft `msg' or `msgs' with
 .BR \-draftmessage .

-Both of these
-commands accept a `file' or `files' argument, and they will, if given
+Both of these commands accept a `file' or `files' argument and they will,
+if given

 .B \-draftfolder
 .B \-draftfolder

-.I +folder
-treat these arguments as `msg' or `msgs'. (This may appear to be
-inconsistent, at first, but it saves a lot of typing) Hence,
+.IR +folder ,
+treat these arguments as `msg' or `msgs'.  (This may appear to be
+inconsistent, at first, but it saves a lot of typing.)  Hence,

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


@@ -132,7 +120,7 @@ profile:
 .PP
 .RS 5
 .nf
 .PP
 .RS 5
 .nf

-Draft\-Folder: +drafts
+Draft\-Folder: drafts

 sendf: \-draftfolder +drafts
 .fi
 .RE
 sendf: \-draftfolder +drafts
 .fi
 .RE


@@ -143,7 +131,7 @@ is a (symbolic) link in the user's
 .I $HOME/bin/
 directory to
 .BR send .
 .I $HOME/bin/
 directory to
 .BR send .

-Then, any of the commands
+Now,

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


@@ -154,11 +142,11 @@ repl
 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

-constructs the message draft in the `draft' folder using the `new'
+will construct the message draft in the `draft' folder using the `new'

 message number.  Furthermore, they each define `cur' in this folder to
 be that message draft.  If the user were to use the
 .B quit
 message number.  Furthermore, they each define `cur' in this folder to
 be that message draft.  If the user were to use the
 .B quit

-option at `What now?' level, then later on, if no other draft composition
+option at the `What now?' prompt, then later on, if no other draft composition

 was done, the draft could be sent with simply
 .PP
 .RS 5
 was done, the draft could be sent with simply
 .PP
 .RS 5


@@ -175,19 +163,18 @@ comp -use
 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

-Instead, if other drafts had been composed in the meantime, so that this
-message draft was no longer known as `cur' in the `draft' folder, then
+If other drafts had been composed in the meantime, so that this message
+draft was no longer known as `cur' in the `draft' folder, then

 the user could
 .B scan
 the user could
 .B scan

-the folder to see which message draft in the
-folder should be used for editing or sending.  Clever users could even
-employ a back-quoted
+the folder to see which message draft should be used for editing or sending.
+Clever users could even employ a backquoted

 .B pick
 to do the work:
 .PP
 .RS 5
 .nf
 .B pick
 to do the work:
 .PP
 .RS 5
 .nf

-comp -use `pick +drafts -to nmh-workers`
+comp -use \`pick +drafts -to nmh-workers\`

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


@@ -195,7 +182,7 @@ or
 .PP
 .RS 5
 .nf
 .PP
 .RS 5
 .nf

-sendf `pick +drafts -to nmh-workers`
+sendf \`pick +drafts -to nmh-workers\`

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


@@ -219,16 +206,16 @@ is not included in the profile entry for
 .BR send ,
 since when
 .BR comp ,
 .BR send ,
 since when
 .BR comp ,

-et. al., invoke
+et al, invoke

 .B send
 directly, they supply
 .B send
 .B send
 directly, they supply
 .B send

-with the UNIX pathname of the message draft, and
-.B not
+with the Unix pathname of the message draft;
+.I not

 a
 .B \-draftmessage
 .I msg
 a
 .B \-draftmessage
 .I msg

-argument. As far as
+argument.  As far as

 .B send
 is concerned, a draft folder is not being used.
 .PP
 .B send
 is concerned, a draft folder is not being used.
 .PP


@@ -238,11 +225,10 @@ treats the draft folder like a standard
 .B nmh
 folder in nearly all respects.  There are two exceptions:
 .PP
 .B nmh
 folder in nearly all respects.  There are two exceptions:
 .PP

-First, under no circumstancs will the
+First, under no circumstances will the

 .B \-draftfolder
 .I folder
 switch cause the named folder to become the current folder.
 .B \-draftfolder
 .I folder
 switch cause the named folder to become the current folder.

-.PP

 Obviously, if the folder appeared in the context of a standard
 .I +folder
 argument to an
 Obviously, if the folder appeared in the context of a standard
 .I +folder
 argument to an


@@ -264,7 +250,6 @@ Second, although conceptually
 deletes the `msgs' named in the draft folder, it does not call
 .I delete\-prog
 to perform the deletion.
 deletes the `msgs' named in the draft folder, it does not call
 .I delete\-prog
 to perform the deletion.

-

 .SS "What Happens if the Draft Exists"
 When the
 .BR comp ,
 .SS "What Happens if the Draft Exists"
 When the
 .BR comp ,


@@ -274,12 +259,12 @@ and
 .B repl
 commands
 are invoked and the draft you indicated already exists, these programs
 .B repl
 commands
 are invoked and the draft you indicated already exists, these programs

-will prompt the user for a reponse directing the program's action.
+will prompt the user for a response directing the program's action.

 The prompt is
 .PP
 .RS 5
 .nf
 The prompt is
 .PP
 .RS 5
 .nf

-Draft ``/home/foobar/nmhbox/draft'' exists (xx bytes).
+Draft "/home/foobar/nmhbox/draft" exists (xx bytes).

 Disposition?
 .fi
 .RE
 Disposition?
 .fi
 .RE


@@ -287,14 +272,20 @@ Disposition?
 The appropriate responses and their meanings are:
 .PP
 .RS 5
 The appropriate responses and their meanings are:
 .PP
 .RS 5

-.fc ^ ~
-.nf
-.ta \w'replace 'u
-.BR ^replace~^ "- deletes the draft and starts afresh"
-.BR ^list~^ "- lists the draft"
-.BR ^refile~^ "- files the draft into a folder and starts afresh"
-.BR ^quit~^ "- leaves the draft intact and exits"
-.fi
+.PD 0
+.TP 10
+.B replace
+deletes the draft and starts afresh
+.TP
+.B list
+lists the draft
+.TP
+.B refile
+files the draft into a folder and starts afresh
+.TP 10
+.B quit
+leaves the draft intact and exits
+.PD

 .RE
 .PP
 In addition, if you specified
 .RE
 .PP
 In addition, if you specified


@@ -303,11 +294,11 @@ In addition, if you specified
 to the command, then one other response will be accepted:
 .PP
 .RS 5
 to the command, then one other response will be accepted:
 .PP
 .RS 5

-.fc ^ ~
-.nf
-.ta \w'replace 'u
-.BR ^new~^ "- finds a new draft"
-.fi
+.PD 0
+.TP 10
+.B new
+creates a new draft
+.PD

 .RE
 .PP
 just as if
 .RE
 .PP
 just as if


@@ -319,16 +310,27 @@ Finally, the
 command will accept one more response:
 .PP
 .RS 5
 command will accept one more response:
 .PP
 .RS 5

-.fc ^ ~
-.nf
-.ta \w'replace 'u
-.BR ^use~^ "- re-uses the draft"
-.fi
+.PD 0
+.TP 10
+.B use
+re-uses the draft
+.PD

 .RE
 .PP
 just as if
 .B \-use
 had been given.
 .RE
 .PP
 just as if
 .B \-use
 had been given.

-
+.SH FILES
+.PP
+.TP 20
+$HOME/.mh_profile
+The user's profile.
+.SH "PROFILE COMPONENTS"
+.PP
+.PD 0
+.TP 20
+Draft\-Folder:
+For a default draft folder
+.PD

 .SH CONTEXT
 None
 .SH CONTEXT
 None