Added all of the MH sources, including RCS files, in
[mmh] / docs / historical / mh-6.8.5 / doc / whatnow.me
1 .\"     This file is automatically generated.  Do not edit!
2 .\" @(#)$Id: whatnow.rf,v 1.9 1992/10/16 21:36:30 jromine Exp $
3 .SC WHATNOW 1
4 .NA
5 whatnow \- prompting front-end for send
6 .SY
7 whatnow
8 \%[\-draftfolder\ +folder] \%[\-draftmessage\ msg] \%[\-nodraftfolder]
9 \%[\-editor\ editor] \%[\-noedit]
10 \%[\-prompt\ string]
11 \%[file]
12 \%[\-help]
13 .DE
14 \fIWhatnow\fR is the default program that queries the user about the
15 disposition of a composed draft.
16 It is normally invoked by one of
17 \fIcomp\fR, \fIdist\fR, \fIforw\fR, or \fIrepl\fR
18 after the initial edit.
19
20 When started,
21 the editor is started on the draft
22 (unless `\-noedit' is given, in which case the initial edit is suppressed).
23 Then, \fIwhatnow\fR repetitively
24 prompts the user with \*(lqWhat now?\*(rq and awaits a response.
25 The valid responses are:
26
27 .nf
28 .in .5i
29 .ta \w'\fBrefile +folder\fR  'u
30 ^\fBdisplay\fR~^to list the message being distributed/replied\-to on
31 ^~^the terminal
32 ^\fBedit\fR~^to re\-edit using the same editor that was used on the
33 ^~^preceding round unless a profile entry
34 ^~^\*(lq<lasteditor>\-next: <editor>\*(rq names an alternate editor
35 ^\fBedit <editor>\fR~^to invoke <editor> for further editing
36 ^\fBlist\fR~^to list the draft on the terminal
37 ^\fBpush\fR~^to send the message in the background
38 ^\fBquit\fR~^to terminate the session and preserve the draft
39 ^\fBquit \-delete\fR~^to terminate, then delete the draft
40 ^\fBrefile +folder\fR~^to refile the draft into the given folder
41 ^\fBsend\fR~^to send the message
42 ^\fBsend \-watch\fR~^to cause the delivery process to be monitored
43 ^\fBwhom\fR~^to list the addresses that the message will go to
44 ^\fBwhom \-check\fR~^to list the addresses and verify that they are
45 ^~^acceptable to the transport service
46 .fi
47 .re
48
49 For the \fBedit\fR response,
50 any valid switch to the editor is valid.
51 Similarly,
52 for the \fBsend\fR and \fBwhom\fR responses,
53 any valid switch to \fIsend\fR\0(1) and \fIwhom\fR\0(1) commands,
54 respectively,
55 are valid.
56 For the \fBpush\fR response,
57 any valid switch to \fIsend\fR\0(1) is valid
58 (as this merely invokes \fIsend\fR with the `\-push' option).
59 For the \fIrefile\fR response,
60 any valid switch to the \fIfileproc\fR is valid.
61 For the \fBdisplay\fR and \fBlist\fR responses,
62 any valid argument to the \fIlproc\fR is valid.
63 If any non\-switch arguments are present,
64 then the pathname of the draft will be excluded from the argument list
65 given to the \fIlproc\fR
66 (this is useful for listing another \fIMH\fR message).
67
68 See \fImh\-profile\fR\0(5) for further information
69 about how editors are used by MH.
70 It also discusses how complex envariables can be used to direct
71 \fIwhatnow\fR's actions.
72
73 The `\-prompt\ string' switch sets the prompting string for \fIwhatnow\fR.
74
75 The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke the
76 \fIMH\fR draft folder facility.
77 This is an advanced (and highly useful) feature.
78 Consult the \fBAdvanced Features\fR section of the \fIMH\fR manual for more
79 information.
80 .Fi
81 ^$HOME/\&.mh\(ruprofile~^The user profile
82 ^<mh\-dir>/draft~^The draft file
83 .Pr
84 ^Path:~^To determine the user's MH directory
85 .Ps
86 ^Draft\-Folder:~^To find the default draft\-folder
87 .Ps
88 ^Editor:~^To override the default editor
89 .Ps
90 ^<lasteditor>\-next:~^To name an editor to be used after exit from <lasteditor>
91 .Ps
92 ^automhnproc:~^Program to automatically run prior to sending
93 ^~^if the draft is an \fImhn\fR composition file
94 .Ps
95 ^fileproc:~^Program to refile the message
96 .Ps
97 ^lproc:~^Program to list the contents of a message
98 .Ps
99 ^sendproc:~^Program to use to send the message
100 .Ps
101 ^whomproc:~^Program to determine who a message would go to
102 .Sa
103 send(1), whom(1)
104 .De
105 `\-prompt\ \*(lqWhat\ Now?\ \*(rq'
106 .Co
107 None
108 .Bu
109 The argument to the `\-prompt' switch must be interpreted as a single token
110 by the shell that invokes \fIwhatnow\fR.
111 Therefore,
112 one must usually place the argument to this switch inside double\-quotes.
113
114 If the initial edit fails, \fIwhatnow\fR deletes your draft (by renaming
115 it with a leading comma); failure of a later edit preverves the draft.
116
117 If \fIwhatnowproc\fR is \fIwhatnow\fR,
118 then \fIcomp\fR, \fIdist\fP, \fIforw\fP, and \fIrepl\fP use
119 a built\-in \fIwhatnow\fR,
120 and do not actually run the \fIwhatnow\fR program.
121 Hence, if you define your own \fIwhatnowproc\fR,
122 don't call it \fIwhatnow\fR since it won't be run.
123
124 If \fIsendproc\fR is \fIsend\fR,
125 then \fIwhatnow\fR uses a built\-in \fIsend\fR,
126 it does not actually run the \fIsend\fR program.
127 Hence, if you define your own \fIsendproc\fR,
128 don't call it \fIsend\fR since \fIwhatnow\fR won't run it.
129 .En