Remove RCS keywords, since they no longer work after git migration.
[mmh] / man / whatnow.man
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH WHATNOW %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
5 .SH NAME
6 whatnow \- prompting front-end for sending messages
7 .SH SYNOPSIS
8 .HP 5
9 .na
10 .B whatnow
11 .RB [ \-draftfolder
12 .IR +folder ]
13 .RB [ \-draftmessage
14 .IR msg ]
15 .RB [ \-nodraftfolder ]
16 .RB [ \-editor
17 .IR editor ]
18 .RB [ \-noedit ]
19 .RB [ \-prompt
20 .IR string ]
21 .RI [ file ]
22 .RB [ \-version ]
23 .RB [ \-help ]
24 .RB [ \-attach
25 .IR header-field-name ]
26 .ad
27 .SH DESCRIPTION
28 .B Whatnow
29 is the default program that queries the user about
30 the disposition of a composed draft.  It is normally automatically
31 invoked by one of the
32 .B nmh
33 commands
34 .BR comp ,
35 .BR dist ,
36 .BR forw ,
37 or
38 .B repl
39 after the initial edit.
40 .PP
41 When started, the editor is started on the draft (unless
42 .B \-noedit
43 is given, in which case the initial edit is suppressed).  Then,
44 .B whatnow
45 repetitively prompts the user with \*(lqWhat now?\*(rq
46 and awaits a response.  The valid responses are:
47 .PP
48 .RS 5
49 .TP \w'refilezzzzfolderz'u
50 .B edit
51 re\-edit using the same editor that was used on the
52 preceding round unless a profile entry
53 \*(lq<lasteditor>\-next: <editor>\*(rq names an alternate editor
54 .TP \w'refilezzzzfolderz'u
55 .B edit <editor>
56 invoke <editor> for further editing
57 .TP \w'refilezzzzfolderz'u
58 .B refile +folder
59 refile the draft into the given folder
60 .TP \w'refilezzzzfolderz'u
61 .B mime
62 process the draft as MIME composition file using
63 the
64 .I buildmimeproc
65 command
66 .RB ( mhbuild
67 by default)
68 .TP \w'refilezzzzfolderz'u
69 .B display
70 list the message being distributed/replied\-to
71 on the terminal
72 .TP \w'refilezzzzfolderz'u
73 .B list
74 list the draft on the terminal
75 .TP \w'refilezzzzfolderz'u
76 .B send
77 send the message
78 .TP \w'refilezzzzfolderz'u
79 .B send \-watch
80 send the message and monitor the delivery process
81 .TP \w'refilezzzzfolderz'u
82 .B push
83 send the message in the background
84 .TP \w'refilezzzzfolderz'u
85 .B whom
86 list the addresses that the message will go to
87 .TP \w'refilezzzzfolderz'u
88 .B whom \-check
89 list the addresses and verify that they are
90 acceptable to the transport service
91 .TP \w'refilezzzzfolderz'u
92 .B quit
93 preserve the draft and exit
94 .TP \w'refilezzzzfolderz'u
95 .B quit \-delete
96 delete the draft and exit
97 .TP \w'refilezzzzfolderz'u
98 .B delete
99 delete the draft and exit
100 .TP \w'refilezzzzfolderz'u
101 .B cd directory
102 use the directory when interpreting attachment file names
103 .TP \w'refilezzzzfolderz'u
104 .B pwd
105 print the working directory for attachment files
106 .TP \w'refilezzzzfolderz'u
107 .B ls [ls-options]
108 list files in the attachment working directory using the ls command
109 .TP \w'refilezzzzfolderz'u
110 .B attach files
111 add the named files to the draft as MIME attachments
112 .TP \w'refilezzzzfolderz'u
113 .B alist [-ln]
114 list the MIME attachments, either short, long [-l] or numbered [-n]
115 .TP \w'refilezzzzfolderz'u
116 .B detach [-n] files-or-numbers
117 remove MIME attachments, either by file name or by number with -n
118 .RE
119 .PP
120 When entering your response, you need only type enough characters
121 to uniquely identify the response.
122 .PP
123 For the
124 .B edit
125 response, any valid switch to the editor is valid.
126 .PP
127 For the
128 .B send
129 and
130 .B push
131 responses, any valid switch to
132 .BR send (1)
133 is valid (as
134 .B push
135 merely invokes
136 .B send
137 with the
138 .B \-push
139 option).
140 .PP
141 For the
142 .B whom
143 response, any valid switch to
144 .BR whom (1)
145 is valid.
146 .PP
147 For the
148 .B refile
149 response, any valid switch to the
150 .I fileproc
151 is valid.
152 .PP
153 For the
154 .B display
155 and
156 .B list
157 responses, any valid argument to
158 the
159 .I lproc
160 is valid.  If any non\-switch arguments are present, then
161 the pathname of the draft will be excluded from the argument list given
162 to the
163 .I lproc
164 (this is useful for listing another
165 .B nmh
166 message).
167 .PP
168 See
169 .BR mh\-profile (5)
170 for further information about how editors
171 are used by
172 .BR nmh .
173 It also discusses how environment variables can be
174 used to direct
175 .BR whatnow 's
176 actions in complex ways.
177 .PP
178 The
179 .B \-prompt
180 .I string
181 switch sets the prompting string for
182 .BR whatnow .
183 .PP
184 The
185 .B \-draftfolder
186 .I +folder
187 and
188 .B \-draftmessage
189 .I msg
190 switches invoke
191 the
192 .B nmh
193 draft folder facility.  This is an advanced (and highly
194 useful) feature.  Consult the
195 .BR mh-draft (5)
196 man page for more
197 information.
198
199 .SH FILES
200 .fc ^ ~
201 .nf
202 .ta \w'%etcdir%/ExtraBigFileName  'u
203 ^$HOME/\&.mh\(ruprofile~^The user profile
204 ^<mh\-dir>/draft~^The draft file
205 .fi
206
207 .SH "PROFILE COMPONENTS"
208 .fc ^ ~
209 .nf
210 .ta 2.4i
211 .ta \w'ExtraBigProfileName  'u
212 ^Path:~^To determine the user's nmh directory
213 ^Draft\-Folder:~^To find the default draft\-folder
214 ^Editor:~^To override the default editor
215 ^<lasteditor>\-next:~^To name an editor to be used after exit
216 ^~^from <lasteditor>
217 ^automimeproc:~^If value is 1, and the draft is a MIME
218 ^~^composition file, then automatically call
219 ^~^buildmimeproc prior to sending.
220 ^buildmimeproc:~^Program to translate MIME composition files
221 ^fileproc:~^Program to refile the message
222 ^lproc:~^Program to list the contents of a message
223 ^sendproc:~^Program to use to send the message
224 ^whomproc:~^Program to determine who a message would go to
225 .fi
226
227 .SH "SEE ALSO"
228 send(1), whom(1)
229
230 .SH DEFAULTS
231 .nf
232 .RB ` \-prompt "' defaults to \*(lqWhat\ Now?\ \*(rq"
233 .fi
234
235 .SH CONTEXT
236 None
237
238 .SH BUGS
239 The argument to the
240 .B \-prompt
241 switch must be interpreted as a single
242 token by the shell that invokes
243 .BR whatnow .
244 Therefore, one must
245 usually place the argument to this switch inside double\-quotes.
246 .PP
247 If the initial edit fails,
248 .B whatnow
249 deletes your draft (by renaming
250 it with a leading comma); failure of a later edit preserves the draft.
251 .PP
252 If the
253 .I buildmimeproc
254 fails (returns a nonzero status),
255 .B whatnow
256 simply prints a \*(lqWhat now?\*(rq prompt.
257 .B whatnow
258 depends on the
259 .I buildmimeproc
260 to tell the user that something went wrong.
261 .PP
262 If
263 .I whatnowproc
264 is
265 .BR whatnow ,
266 then
267 .BR comp ,
268 .BR dist ,
269 .BR forw ,
270 and
271 .B repl
272 use a built\-in
273 .BR whatnow ,
274 and do not actually run the
275 .B whatnow
276 program.  Hence, if you define your own
277 .IR whatnowproc ,
278 don't call it
279 .B whatnow
280 since it won't be run.
281 .PP
282 If
283 .I sendproc
284 is
285 .BR send ,
286 then
287 .B whatnow
288 uses a built\-in
289 .BR send ,
290 it does not actually run the
291 .B send
292 program.  Hence, if
293 you define your own
294 .IR sendproc ,
295 don't call it
296 .B send
297 since
298 .B whatnow
299 won't run it.