Removed the draft message in favor for a consistent draft folder facility
[mmh] / man / mh-draft.man
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH MH-DRAFT %manext5% "%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 \*(lq Draft\-Folder \*(rq
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 known as `cur' 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 `cur'.
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.  Let's assume
53 that the following entries are in the
54 .B nmh
55 profile:
56 .PP
57 .RS 5
58 .nf
59 Draft\-Folder: +drafts
60 .fi
61 .RE
62 .PP
63 Any of the commands
64 .PP
65 .RS 5
66 .nf
67 comp
68 dist
69 forw
70 repl
71 .fi
72 .RE
73 .PP
74 constructs the message draft in the draft folder using the `new'
75 message number.  Furthermore, they each define `cur' in this folder to
76 be that message draft.  If the user were to use the
77 .B quit
78 option at `What now?' level, then later on, if no other draft composition
79 was done, the draft could be sent with simply
80 .PP
81 .RS 5
82 .nf
83 send
84 .fi
85 .RE
86 .PP
87 Or, if more editing was required, the draft could be edited with
88 .PP
89 .RS 5
90 .nf
91 comp -use
92 .fi
93 .RE
94 .PP
95 Instead, if other drafts had been composed in the meantime, so that this
96 message draft was no longer known as `cur' in the `draft' folder, then
97 the user could
98 .B scan
99 the folder to see which message draft in the
100 folder should be used for editing or sending.  Clever users could even
101 employ a back-quoted
102 .B pick
103 to do the work:
104 .PP
105 .RS 5
106 .nf
107 comp -use `pick +drafts -to nmh-workers`
108 .fi
109 .RE
110 .PP
111 or
112 .PP
113 .RS 5
114 .nf
115 send `pick +drafts -to nmh-workers`
116 .fi
117 .RE
118 .PP
119 Note that in the
120 .B comp
121 example, the output from
122 .B pick
123 must resolve to a single message draft (it makes no sense to talk about
124 composing two or more drafts with one invocation of
125 .BR comp ).
126 In contrast, in the
127 .B send
128 example, as many message drafts as desired can appear, since
129 .B send
130 doesn't mind sending more than one draft at a time.
131 .PP
132 It is important to realize that
133 .B nmh
134 treats the draft folder like a standard
135 .B nmh
136 folder in nearly all respects.  There is one exception:
137 Although conceptually
138 .B send
139 deletes the `msgs' named in the draft folder, it does not call
140 .I delete\-prog
141 to perform the deletion.
142 .SH CONTEXT
143 None