annotate doc/whatnow.me @ 0:bce86c4163a3

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