Mercurial > hg > Applications > mh

comparison doc/prompter.me @ 0:bce86c4163a3

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