Updated man pages: Removed the notice that whatnow could be called internally.
[mmh] / man / whatnow.man1
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 [ \-editor
12 .IR editor ]
13 .RB [ \-noedit ]
14 .RB [ \-prompt
15 .IR string ]
16 .RI [ file ]
17 .RB [ \-version ]
18 .RB [ \-help ]
19 .ad
20 .SH DESCRIPTION
21 .B Whatnow
22 is the default program that queries the user about
23 the disposition of a composed draft.  It is normally automatically
24 invoked by one of the
25 .B nmh
26 commands
27 .BR comp ,
28 .BR dist ,
29 .BR forw ,
30 or
31 .B repl
32 after the initial edit.
33 .PP
34 When started, the editor is started on the draft (unless
35 .B \-noedit
36 is given, in which case the initial edit is suppressed).  Then,
37 .B whatnow
38 repetitively prompts the user with \*(lqWhat now?\*(rq
39 and awaits a response.  The valid responses are:
40 .PP
41 .RS 5
42 .TP \w'refilezzzzfolderz'u
43 .B edit
44 re\-edit using the same editor that was used on the
45 preceding round unless a profile entry
46 \*(lq<lasteditor>\-next: <editor>\*(rq names an alternate editor
47 .TP \w'refilezzzzfolderz'u
48 .B edit <editor>
49 invoke <editor> for further editing
50 .TP \w'refilezzzzfolderz'u
51 .B refile +folder
52 refile the draft into the given folder
53 .TP \w'refilezzzzfolderz'u
54 .B display
55 list the message being distributed/replied\-to
56 on the terminal
57 .TP \w'refilezzzzfolderz'u
58 .B list
59 list the draft on the terminal
60 .TP \w'refilezzzzfolderz'u
61 .B send
62 send the message
63 .TP \w'refilezzzzfolderz'u
64 .B send \-watch
65 send the message and monitor the delivery process
66 .TP \w'refilezzzzfolderz'u
67 .B push
68 send the message in the background
69 .TP \w'refilezzzzfolderz'u
70 .B quit
71 preserve the draft and exit
72 .TP \w'refilezzzzfolderz'u
73 .B delete
74 delete the draft and exit
75 .TP \w'refilezzzzfolderz'u
76 .B cd directory
77 use the directory when interpreting attachment file names
78 .TP \w'refilezzzzfolderz'u
79 .B pwd
80 print the working directory for attachment files
81 .TP \w'refilezzzzfolderz'u
82 .B ls [ls-options]
83 list files in the attachment working directory using the ls command
84 .TP \w'refilezzzzfolderz'u
85 .B attach files
86 add the named files to the draft as MIME attachments
87 .TP \w'refilezzzzfolderz'u
88 .B alist [-ln]
89 list the MIME attachments, either short, long [-l] or numbered [-n]
90 .TP \w'refilezzzzfolderz'u
91 .B detach [-n] files-or-numbers
92 remove MIME attachments, either by file name or by number with -n
93 .RE
94 .PP
95 When entering your response, you need only type enough characters
96 to uniquely identify the response.
97 .PP
98 For the
99 .B edit
100 response, any valid switch to the editor is valid.
101 .PP
102 For the
103 .B send
104 and
105 .B push
106 responses, any valid switch to
107 .BR send (1)
108 is valid (as
109 .B push
110 merely invokes
111 .B send
112 with the
113 .B \-push
114 option).
115 .PP
116 For the
117 .B refile
118 response, any valid switch to the
119 .I fileproc
120 is valid.
121 .PP
122 For the
123 .B display
124 and
125 .B list
126 responses, any valid argument to
127 the
128 .I lproc
129 is valid.  If any non\-switch arguments are present, then
130 the pathname of the draft will be excluded from the argument list given
131 to the
132 .I lproc
133 (this is useful for listing another
134 .B nmh
135 message).
136 .PP
137 See
138 .BR mh\-profile (5)
139 for further information about how editors
140 are used by
141 .BR nmh .
142 It also discusses how environment variables can be
143 used to direct
144 .BR whatnow 's
145 actions in complex ways.
146 .PP
147 The
148 .B \-prompt
149 .I string
150 switch sets the prompting string for
151 .BR whatnow .
152 .PP
153 Consult the
154 .BR mh-draft (7)
155 man page for more
156 information.
157
158 .SH FILES
159 .fc ^ ~
160 .nf
161 .ta \w'%etcdir%/ExtraBigFileName  'u
162 ^$HOME/.mmh/profile~^The user profile
163 ^+drafts~^The draft folder
164 .fi
165
166 .SH "PROFILE COMPONENTS"
167 .fc ^ ~
168 .nf
169 .ta 2.4i
170 .ta \w'ExtraBigProfileName  'u
171 ^Path:~^To determine the user's mail storage
172 ^Draft\-Folder:~^To set the default draft\-folder
173 ^Editor:~^To override the default editor
174 ^<lasteditor>\-next:~^To name an editor to be used after exit
175 ^~^from <lasteditor>
176 ^fileproc:~^Program to refile the message
177 ^lproc:~^Program to list the contents of a message
178 ^sendproc:~^Program to use to send the message
179 .fi
180
181 .SH "SEE ALSO"
182 send(1)
183
184 .SH DEFAULTS
185 .nf
186 .RB ` \-prompt "' defaults to \*(lqWhat\ Now?\ \*(rq"
187 .fi
188
189 .SH CONTEXT
190 None
191
192 .SH BUGS
193 The argument to the
194 .B \-prompt
195 switch must be interpreted as a single
196 token by the shell that invokes
197 .BR whatnow .
198 Therefore, one must
199 usually place the argument to this switch inside double\-quotes.
200 .PP
201 If the initial edit fails,
202 .B whatnow
203 deletes your draft (by renaming
204 it with a leading comma); failure of a later edit preserves the draft.