source: trunk/third/nmh/man/whatnow.man @ 12455

Revision 12455, 4.8 KB checked in by danw, 26 years ago (diff)
This commit was generated by cvs2svn to compensate for changes in r12454, which included commits to RCS files with non-trunk default branches.
Line 
1.\"
2.\" %nmhwarning%
3.\" $Id: whatnow.man,v 1.1.1.1 1999-02-07 18:14:22 danw Exp $
4.\"
5.\" include the -mh macro file
6.so %etcdir%/tmac.h
7.\"
8.TH WHATNOW %manext1% MH.6.8 [%nmhversion%]
9.SH NAME
10whatnow \- prompting front-end for sending messages
11.SH SYNOPSIS
12.in +.5i
13.ti -.5i
14whatnow
15\%[\-draftfolder\ +folder] \%[\-draftmessage\ msg]
16.br
17\%[\-nodraftfolder]
18\%[\-editor\ editor] \%[\-noedit]
19.br
20\%[\-prompt\ string]
21\%[file]
22\%[\-version]
23\%[\-help]
24.in -.5i
25.SH DESCRIPTION
26\fIWhatnow\fR is the default program that queries the user about
27the disposition of a composed draft.  It is normally automatically
28invoked by one of the \fInmh\fR commands \fIcomp\fR, \fIdist\fR,
29\fIforw\fR, or \fIrepl\fR after the initial edit.
30
31When started, the editor is started on the draft (unless `\-noedit'
32is given, in which case the initial edit is suppressed).  Then,
33\fIwhatnow\fR repetitively prompts the user with \*(lqWhat now?\*(rq
34and awaits a response.  The valid responses are:
35
36.nf
37.in .5i
38.ta \w'\fBrefile +folder\fR  'u
39^\fBedit\fR~^re\-edit using the same editor that was used on the
40^~^preceding round unless a profile entry
41^~^\*(lq<lasteditor>\-next: <editor>\*(rq names an alternate editor
42^\fBedit <editor>\fR~^invoke <editor> for further editing
43^\fBrefile +folder\fR~^refile the draft into the given folder
44^\fBmime\fR~^process the draft as MIME composition file using
45^~^the "buildmimeproc" command (mhbuild by default)
46^\fBdisplay\fR~^list the message being distributed/replied\-to
47^~^on the terminal
48^\fBlist\fR~^list the draft on the terminal
49^\fBsend\fR~^send the message
50^\fBsend \-watch\fR~^send the message and monitor the delivery process
51^\fBpush\fR~^send the message in the background
52^\fBwhom\fR~^list the addresses that the message will go to
53^\fBwhom \-check\fR~^list the addresses and verify that they are
54^~^acceptable to the transport service
55^\fBquit\fR~^preserve the draft and exit
56^\fBquit \-delete\fR~^delete the draft and exit
57^\fBdelete\fR~^delete the draft and exit
58.fi
59.re
60
61When entering your response, you need only type enough characters
62to uniquely identify the response.
63
64For the \fBedit\fR response, any valid switch to the editor is valid.
65
66For the \fBsend\fR and \fBpush\fR responses, any valid switch to
67\fIsend\fR\0(1) are valid (as \fBpush\fR merely invokes \fIsend\fR
68with the `\-push' option).
69
70For the \fBwhom\fR response, any valid switch to \fIwhom\fR\0(1)
71is valid.
72
73For the \fBrefile\fR response, any valid switch to the \fIfileproc\fR
74is valid.
75
76For the \fBdisplay\fR and \fBlist\fR responses, any valid argument to
77the \fIlproc\fR is valid.  If any non\-switch arguments are present, then
78the pathname of the draft will be excluded from the argument list given
79to the \fIlproc\fR (this is useful for listing another \fInmh\fR message).
80
81See \fImh\-profile\fR\0(5) for further information about how editors
82are used by nmh.  It also discusses how environment variables can be
83used to direct \fIwhatnow\fR's actions in complex ways.
84
85The `\-prompt\ string' switch sets the prompting string for \fIwhatnow\fR.
86
87The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke
88the \fInmh\fR draft folder facility.  This is an advanced (and highly
89useful) feature.  Consult the \fImh-draft\fR(5) man page for more
90information.
91
92.Fi
93^$HOME/\&.mh\(ruprofile~^The user profile
94^<mh\-dir>/draft~^The draft file
95.Pr
96^Path:~^To determine the user's nmh directory
97.Ps
98^Draft\-Folder:~^To find the default draft\-folder
99.Ps
100^Editor:~^To override the default editor
101.Ps
102^<lasteditor>\-next:~^To name an editor to be used after exit
103^~^from <lasteditor>
104.Ps
105^automimeproc:~^If value is 1, and the draft is a MIME
106^~^composition file, then automatically call
107^~^buildmimeproc prior to sending.
108.Ps
109^buildmimeproc:~^Program to translate MIME composition files
110.Ps
111^fileproc:~^Program to refile the message
112.Ps
113^lproc:~^Program to list the contents of a message
114.Ps
115^sendproc:~^Program to use to send the message
116.Ps
117^whomproc:~^Program to determine who a message would go to
118.Sa
119send(1), whom(1)
120.De
121`\-prompt\ \*(lqWhat\ Now?\ \*(rq'
122.Co
123None
124.Bu
125The argument to the `\-prompt' switch must be interpreted as a single
126token by the shell that invokes \fIwhatnow\fR.  Therefore, one must
127usually place the argument to this switch inside double\-quotes.
128
129If the initial edit fails, \fIwhatnow\fR deletes your draft (by renaming
130it with a leading comma); failure of a later edit preserves the draft.
131
132If \fIwhatnowproc\fR is \fIwhatnow\fR, then \fIcomp\fR, \fIdist\fP,
133\fIforw\fP, and \fIrepl\fP use a built\-in \fIwhatnow\fR, and do not
134actually run the \fIwhatnow\fR program.  Hence, if you define your own
135\fIwhatnowproc\fR, don't call it \fIwhatnow\fR since it won't be run.
136
137If \fIsendproc\fR is \fIsend\fR, then \fIwhatnow\fR uses a built\-in
138\fIsend\fR, it does not actually run the \fIsend\fR program.  Hence, if
139you define your own \fIsendproc\fR, don't call it \fIsend\fR since
140\fIwhatnow\fR won't run it.
141.En
Note: See TracBrowser for help on using the repository browser.