annotate doc/prompter.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 PROMPTER 1
bce86c4163a3 Initial revision
kono
parents:
diff changeset
4 .NA
bce86c4163a3 Initial revision
kono
parents:
diff changeset
5 prompter \- prompting editor front-end for MH
bce86c4163a3 Initial revision
kono
parents:
diff changeset
6 .SY
bce86c4163a3 Initial revision
kono
parents:
diff changeset
7 prompter
bce86c4163a3 Initial revision
kono
parents:
diff changeset
8 \%[\-erase\ chr]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
9 \%[\-kill\ chr]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
10 \%[\-prepend] \%[\-noprepend]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
11 \%[\-rapid] \%[\-norapid]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
12 \%[\-doteof] \%[\-nodoteof]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
13 file
bce86c4163a3 Initial revision
kono
parents:
diff changeset
14 \%[\-help]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
15 .DE
bce86c4163a3 Initial revision
kono
parents:
diff changeset
16 This program is normally not invoked directly by users
bce86c4163a3 Initial revision
kono
parents:
diff changeset
17 but takes the place of an editor and acts as an editor front\-end.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
18 It operates on an 822\-style message draft skeleton specified by file,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
19 normally provided by \fIcomp\fR, \fIdist\fR, \fIforw\fR, or \fIrepl\fR.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
20
bce86c4163a3 Initial revision
kono
parents:
diff changeset
21 \fIPrompter\fR is an editor which allows rapid composition of
bce86c4163a3 Initial revision
kono
parents:
diff changeset
22 messages.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
23 It is particularly useful to network and low\-speed
bce86c4163a3 Initial revision
kono
parents:
diff changeset
24 (less than 2400 baud) users of \fIMH\fR.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
25 It is an \fIMH\fR program in that
bce86c4163a3 Initial revision
kono
parents:
diff changeset
26 it can have its own profile entry with switches,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
27 but it is not invoked directly by the user.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
28 The commands \fIcomp\fR, \fIdist\fR, \fIforw\fR, and \fIrepl\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
29 invoke \fIprompter\fR as an editor,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
30 either when invoked with `\-editor\ prompter',
bce86c4163a3 Initial revision
kono
parents:
diff changeset
31 or by the profile entry \*(lqEditor:\ prompter\*(rq,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
32 or when given the command `edit\ prompter' at \*(lqWhat now?\*(rq level.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
33
bce86c4163a3 Initial revision
kono
parents:
diff changeset
34 For each empty component \fIprompter\fR finds in the draft,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
35 the user is prompted for a response;
bce86c4163a3 Initial revision
kono
parents:
diff changeset
36 A <RETURN> will cause the whole component to be left out.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
37 Otherwise,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
38 a `\\' preceding a <RETURN> will continue the response on the next line,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
39 allowing for multiline components.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
40 Continuation lines \fBmust\fR begin with a space or tab.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
41
bce86c4163a3 Initial revision
kono
parents:
diff changeset
42 Each non\-empty component is copied to the draft and displayed on the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
43 terminal.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
44
bce86c4163a3 Initial revision
kono
parents:
diff changeset
45 The start of the message body is denoted by a blank line or a line of dashes.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
46 If the body is non\-empty, the prompt, which isn't written to the file, is
bce86c4163a3 Initial revision
kono
parents:
diff changeset
47
bce86c4163a3 Initial revision
kono
parents:
diff changeset
48 \*(lq--------Enter additional text\*(rq,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
49
bce86c4163a3 Initial revision
kono
parents:
diff changeset
50 or (if `\-prepend' was given)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
51
bce86c4163a3 Initial revision
kono
parents:
diff changeset
52 \*(lq--------Enter initial text\*(rq.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
53
bce86c4163a3 Initial revision
kono
parents:
diff changeset
54 Message\-body typing is terminated with an end\-of\-file (usually CTRL\-D).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
55 With the `\-doteof' switch, a period on a line all by itself also signifies
bce86c4163a3 Initial revision
kono
parents:
diff changeset
56 end\-of\-file.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
57 At this point control is returned to the calling program,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
58 where the user is asked \*(lqWhat now?\*(rq.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
59 See \fIwhatnow\fR for the valid options to this query.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
60
bce86c4163a3 Initial revision
kono
parents:
diff changeset
61 By using the `\-prepend' switch, the user can add type\-in to the beginning
bce86c4163a3 Initial revision
kono
parents:
diff changeset
62 of the message body and have the rest of the body follow.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
63 This is useful for the \fIforw\fR command.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
64
bce86c4163a3 Initial revision
kono
parents:
diff changeset
65 By using the `\-rapid' switch,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
66 if the draft already contains text in the message\-body,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
67 it is not displayed on the user's terminal.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
68 This is useful for low\-speed terminals.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
69
bce86c4163a3 Initial revision
kono
parents:
diff changeset
70 The line editing characters for kill and erase may be
bce86c4163a3 Initial revision
kono
parents:
diff changeset
71 specified by the user via the arguments `\-kill\ chr' and `\-erase\ chr',
bce86c4163a3 Initial revision
kono
parents:
diff changeset
72 where chr may be a character; or `\\nnn', where \*(lqnnn\*(rq is the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
73 octal value for the character.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
74
bce86c4163a3 Initial revision
kono
parents:
diff changeset
75 An interrupt (usually CTRL\-C) during component typing will abort
bce86c4163a3 Initial revision
kono
parents:
diff changeset
76 \fIprompter\fR and the \fIMH\fR command that invoked it.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
77 An interrupt during message\-body typing is equivalent to CTRL\-D,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
78 for historical reasons.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
79 This means that \fIprompter\fR should finish up and exit.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
80
bce86c4163a3 Initial revision
kono
parents:
diff changeset
81 The first non\-flag argument to \fIprompter\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
82 is taken as the name of the draft file, and
bce86c4163a3 Initial revision
kono
parents:
diff changeset
83 subsequent non\-flag arguments are ignored.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
84 .\" (\fIRepl\fR invokes editors with two file arguments:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
85 .\" the draft file name and the replied\-to message file name.)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
86 .Fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
87 ^$HOME/\&.mh\(ruprofile~^The user profile
bce86c4163a3 Initial revision
kono
parents:
diff changeset
88 ^/tmp/prompter*~^Temporary copy of message
bce86c4163a3 Initial revision
kono
parents:
diff changeset
89 .Pr
bce86c4163a3 Initial revision
kono
parents:
diff changeset
90 prompter\-next: To name the editor to be used on exit from \fIprompter\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
91 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
92 ^Msg\-Protect:~^To set mode when creating a new draft
bce86c4163a3 Initial revision
kono
parents:
diff changeset
93 .Sa
bce86c4163a3 Initial revision
kono
parents:
diff changeset
94 comp(1), dist(1), forw(1), repl(1), whatnow(1)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
95 .De
bce86c4163a3 Initial revision
kono
parents:
diff changeset
96 `\-prepend'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
97 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
98 `\-norapid'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
99 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
100 `\-nodoteof'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
101 .Co
bce86c4163a3 Initial revision
kono
parents:
diff changeset
102 None
bce86c4163a3 Initial revision
kono
parents:
diff changeset
103 .Hh
bce86c4163a3 Initial revision
kono
parents:
diff changeset
104 The `\-rapid' option is particularly useful with \fIforw\fP, and
bce86c4163a3 Initial revision
kono
parents:
diff changeset
105 `\-noprepend' is useful with \fIcomp\ \-use\fP.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
106
bce86c4163a3 Initial revision
kono
parents:
diff changeset
107 The user may wish to link \fIprompter\fR under several names
bce86c4163a3 Initial revision
kono
parents:
diff changeset
108 (e.g., \*(lqrapid\*(rq) and give appropriate switches
bce86c4163a3 Initial revision
kono
parents:
diff changeset
109 in the profile entries under these names (e.g., \*(lqrapid: -rapid\*(rq).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
110 This facilitates invoking prompter differently for
bce86c4163a3 Initial revision
kono
parents:
diff changeset
111 different \fIMH\fP commands (e.g., \*(lqforw: -editor rapid\*(rq).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
112 .Bu
bce86c4163a3 Initial revision
kono
parents:
diff changeset
113 \fIPrompter\fR uses \fIstdio\fR\0(3), so it will lose if you edit files
bce86c4163a3 Initial revision
kono
parents:
diff changeset
114 with nulls in them.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
115 .En