File: prompter.man

package info (click to toggle)
nmh 1.8-4
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 7,860 kB
  • sloc: ansic: 50,445; sh: 22,697; makefile: 1,138; lex: 740; perl: 509; yacc: 265
file content (197 lines) | stat: -rw-r--r-- 4,450 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
.TH PROMPTER %manext1% 1999-04-30 "%nmhversion%"
.
.\" %nmhwarning%
.
.SH NAME
prompter \- nmh's prompting editor front-end
.SH SYNOPSIS
.HP 5
.na
.B prompter
.RB [ \-help ]
.RB [ \-version ]
.RB [ \-erase
.IR chr ]
.RB [ \-kill
.IR chr ]
.RB [ \-prepend " | " \-noprepend ]
.RB [ \-rapid " | " \-norapid ]
.RB [ \-doteof " | " \-nodoteof ]
.I file
.ad
.SH DESCRIPTION
.B prompter
is an editor front-end for
.B nmh
which allows rapid composition of messages.
This program is not normally invoked directly by users but takes
the place of an editor and acts as an editor front-end.
It operates on an RFC 822-style message draft skeleton specified by
.IR file ,
normally provided by the
.B nmh
commands
.BR comp ,
.BR dist ,
.BR forw ,
or
.BR repl .
.PP
.B prompter
is particularly useful when composing messages over slow
network or modem lines.  It is an
.B nmh
program in that it can have its own profile entry with switches,
but it is not invoked directly by the user.
The commands
.BR comp ,
.BR dist ,
.BR forw ,
and
.B repl
invoke
.B prompter
as an editor, either when invoked with
.B \-editor
.IR prompter ,
or by the profile entry \*(lqEditor:\ prompter\*(rq,
or when given the command
.B edit
.B prompter
at the \*(lqWhat now?\*(rq prompt.
.PP
For each empty component
.B prompter
finds in the draft, the user is prompted for a response;
A <RETURN> will cause the whole component to be left out.
Otherwise, a `\\' preceding a <RETURN> will continue the
response on the next line, allowing for multiline components.
Continuation lines
.I must
begin with a space or tab.
.PP
Each non-empty component is copied to the draft and displayed on the
terminal.
.PP
The start of the message body is denoted by a blank line or a line
of dashes.  If the body is non-empty, the prompt, which isn't written
to the file, is
.PP
.RS 5
--------Enter additional text
.RE
.PP
or (if
.B \-prepend
was given)
.PP
.RS 5
--------Enter initial text
.RE
.PP
Message-body typing is terminated with an end-of-file (usually
CTRL-D).  With the
.B \-doteof
switch, a period on a line all by itself also signifies end-of-file.
At this point control is returned to the calling program,
where the user is asked \*(lqWhat now?\*(rq.
See
.IR whatnow (1)
for the valid options to this query.
.PP
By using the
.B \-prepend
switch, the user can add type-in to the beginning of the message body
and have the rest of the body follow.
This is useful for the
.B forw
command.
.PP
By using the
.B \-rapid
switch, if the draft already contains text in the message-body, it is
not displayed on the user's terminal.  This is useful for low-speed
terminals.
.PP
The line editing characters for kill and erase may be specified by the
user via the arguments
.B \-kill
.I chr
and
.B \-erase
.IR chr ,
where
.I chr
may be a character; or `\\nnn', where \*(lqnnn\*(rq is the octal value for
the character.
.PP
An interrupt (usually CTRL-C) during component typing will abort
.B prompter
and the
.B nmh
command that invoked it.  An interrupt during message-body typing is
equivalent to CTRL-D, for historical reasons.
This means that
.B prompter
should finish up and exit.
.PP
The first non-flag argument to
.B prompter
is taken as the name of the draft file, and subsequent non-flag
arguments are ignored.
.\" (\fIrepl\fR invokes editors with two file arguments:
.\" the draft file name and the replied-to message file name.)
.SH FILES
.fc ^ ~
.nf
.ta \w'%nmhetcdir%/ExtraBigFileName  'u
^$HOME/.mh_profile~^The user profile
^/tmp/prompter*~^Temporary copy of message
.fi
.SH "PROFILE COMPONENTS"
.fc ^ ~
.nf
.ta 2.4i
.ta \w'ExtraBigProfileName  'u
prompter\-next:	To name the editor to be used on exit from .B prompter
^Msg\-Protect:~^To set mode when creating a new draft
.fi
.SH "SEE ALSO"
.IR comp (1),
.IR dist (1),
.IR forw (1),
.IR repl (1),
.IR whatnow (1)
.SH DEFAULTS
.nf
.RB ` \-prepend '
.RB ` \-norapid '
.RB ` \-nodoteof '
.fi
.SH CONTEXT
None
.SH "HELPFUL HINTS"
The
.B \-rapid
option is particularly useful with
.BR forw ,
and
.B \-noprepend
is useful with
.B comp
.BR \-use .
.PP
The user may wish to link
.B prompter
under several names (e.g., \*(lqrapid\*(rq) and give appropriate
switches in the profile entries under these names
(e.g., \*(lqrapid: -rapid\*(rq).  This facilitates
invoking prompter differently for different
.B nmh
commands (e.g.,
\*(lqforw: -editor rapid\*(rq).
.SH BUGS
.B prompter
uses
.IR stdio (3),
so it will lose if you edit files with nulls in them.