Update the man pages to the shortened reserved sequence names
[mmh] / man / mh-draft.man7
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH MH-DRAFT %manext7% "%nmhdate%" MH.6.8 [%nmhversion%]
5 .SH NAME
6 mh-draft \- draft folder facility for nmh message system
7 .SH SYNOPSIS
8 any
9 .B nmh
10 command
11 .SH DESCRIPTION
12 There are a number of interesting advanced facilities for the composition of
13 outgoing mail.
14 .PP
15 .SS "The Draft Folder"
16 The
17 .BR comp ,
18 .BR dist ,
19 .BR forw ,
20 and
21 .B repl
22 commands allow you to manipulate various draft messages simultanely
23 .PP
24 Draft messages are created in the draft folder.
25 (The
26 .RI ` Draft\-Folder '
27 profile entry may be used to change the default draft folder.
28 .PP
29 New drafts are created unless the user invokes
30 .B comp
31 with
32 .BR \-use ,
33 in which case the current draft is used.
34 .PP
35 The last draft message
36 the user was composing is the current message in the draft folder.
37 .PP
38 The user can send off whatever drafts desired from the shell using the
39 standard
40 .B nmh
41 `msgs' convention to the
42 .B send
43 command..
44 If no `msgs' are given, it defaults to `c'.
45 .PP
46 .RS
47 .nf
48 send first
49 .fi
50 .RE
51 .PP
52 To make all this a bit more clear, here are some examples:
53 .RE
54 .PP
55 Any of the commands
56 .PP
57 .RS 5
58 .nf
59 comp
60 dist
61 forw
62 repl
63 .fi
64 .RE
65 .PP
66 constructs the message draft in the draft folder using the `b'
67 message number.  Furthermore, they each define `c' in this folder to
68 be that message draft.  If the user were to use the
69 .B quit
70 option at `What now?' level, then later on, if no other draft composition
71 was done, the draft could be sent with simply
72 .PP
73 .RS 5
74 .nf
75 send
76 .fi
77 .RE
78 .PP
79 Or, if more editing was required, the draft could be edited with
80 .PP
81 .RS 5
82 .nf
83 comp -use
84 .fi
85 .RE
86 .PP
87 Instead, if other drafts had been composed in the meantime, so that this
88 message draft was no longer known as `c' in the `draft' folder, then
89 the user could
90 .B scan
91 the folder to see which message draft in the
92 folder should be used for editing or sending.  Clever users could even
93 employ a back-quoted
94 .B pick
95 to do the work:
96 .PP
97 .RS 5
98 .nf
99 comp -use `pick +drafts -to nmh-workers`
100 .fi
101 .RE
102 .PP
103 or
104 .PP
105 .RS 5
106 .nf
107 send `pick +drafts -to nmh-workers`
108 .fi
109 .RE
110 .PP
111 Note that in the
112 .B comp
113 example, the output from
114 .B pick
115 must resolve to a single message draft (it makes no sense to talk about
116 composing two or more drafts with one invocation of
117 .BR comp ).
118 In contrast, in the
119 .B send
120 example, as many message drafts as desired can appear, since
121 .B send
122 doesn't mind sending more than one draft at a time.
123 .PP
124 It is important to realize that
125 .B nmh
126 treats the draft folder like a standard
127 .B nmh
128 folder in nearly all respects.  There is one exception:
129 Although conceptually
130 .B send
131 deletes the `msgs' named in the draft folder, it does not call
132 .I delete\-prog
133 to perform the deletion.
134 .SH CONTEXT
135 None