git.marmaro.de Git - mmh/blob - man/prompter.man1

   1 .\"
   2 .\" %nmhwarning%
   3 .\"
   4 .TH PROMPTER %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   5 .SH NAME
   6 prompter \- prompting editor front-end for mmh
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B prompter
  11 .RB [ \-prepend " | " \-noprepend ]
  12 .RB [ \-rapid " | " \-norapid ]
  13 .RB [ \-body " | " \-nobody ]
  14 .I file
  15 .RB [ \-Version ]
  16 .RB [ \-help ]
  17 .ad
  18 .SH DESCRIPTION
  19 .B Prompter
  20 is an editor front-end for
  21 .B mmh
  22 which allows rapid
  23 composition of messages.  This program is not normally invoked directly by
  24 users but takes the place of an editor and acts as an editor front-end.
  25 It operates on an RFC-822 style message draft skeleton specified by
  26 .IR file ,
  27 normally provided by the
  28 .B mmh
  29 commands
  30 .BR comp ,
  31 .BR dist ,
  32 .BR forw ,
  33 or
  34 .BR repl .
  35 .PP
  36 .B Prompter
  37 is particularly useful when composing messages over slow
  38 network or modem lines.  It is hardly invoked directly by
  39 the user.  The commands
  40 .BR comp ,
  41 .BR dist ,
  42 .BR forw ,
  43 and
  44 .B repl
  45 invoke
  46 .B prompter
  47 as an editor, either when invoked with
  48 .B \-editor
  49 .IR prompter ,
  50 or by the profile entry `Editor:\ prompter',
  51 or when given the command
  52 .B edit prompter
  53 at the `What now?' prompt.
  54 .PP
  55 For each empty component
  56 .B prompter
  57 finds in the draft, the user
  58 is prompted for a response. An empty response will cause the whole component
  59 to be left out.  Otherwise, a `\\' preceding the Newline will continue
  60 the response on the next line, allowing for multiline components.
  61 Continuation lines
  62 .B must
  63 begin with a space or tab.
  64 .PP
  65 Each non-empty component is copied to the draft and displayed on the
  66 terminal.
  67 .PP
  68 The start of the message body is denoted by a blank line or a line
  69 of dashes.
  70 Unless
  71 .B \-nobody
  72 is specified, the user is queried to enter the message body.
  73 If the body of the draft is non-empty, the typed-in text will be prepended
  74 or appended to the existing body, depending on the
  75 .B \-prepend
  76 and
  77 .B \-noprepend
  78 switches.
  79 In these cases, the prompt (which isn't written to the file) is
  80 .PP
  81 .RS 5
  82 \-\-\-\-\-\-\-\-Enter additional text
  83 .RE
  84 .PP
  85 or (if
  86 .B \-prepend
  87 was given)
  88 .PP
  89 .RS 5
  90 \-\-\-\-\-\-\-\-Enter initial text
  91 .RE
  92 .PP
  93 Message-body typing is terminated with an end-of-file (usually
  94 CTRL-D).
  95 At this point control is returned to
  96 the calling program, where the user is asked `What now?'.
  97 See
  98 .B whatnow (1)
  99 for the valid options to this query.
 100 .PP
 101 By using the
 102 .B \-nobody
 103 switch, the user is only queried to fill in header fields, but not to enter
 104 any body text.
 105 Note, that the
 106 .BR \-body and \-nobody
 107 switches had already existed already in
 108 .B nmh
 109 in undocumented/hidden form,
 110 but with a slightly different meaning.
 111 Back then,
 112 .B "prompter \-nobody
 113 would change the draft to have an empty body,
 114 by ignoring any existing body and not querying the user for body text.
 115 .PP
 116 By using the
 117 .B \-prepend
 118 switch, the user can add type-in to the
 119 beginning of the message body and have the rest of the body follow.
 120 With
 121 .B \-noprepend
 122 the typed-in text is appended to the message body.
 123 .PP
 124 By using the
 125 .B \-rapid
 126 switch, if the draft already contains text in
 127 the message-body, it is not displayed on the user's terminal.  This is
 128 useful for low-speed terminals.
 129 .PP
 130 An interrupt (usually CTRL-C) during component typing will abort
 131 .B prompter
 132 and the
 133 .B mmh
 134 command that invoked it.  An interrupt
 135 during message-body typing is equivalent to CTRL-D, for historical
 136 reasons and to avoid losing the typed-in message text.  This means that
 137 .B prompter
 138 should finish up and exit, usually putting the user back to the
 139 Whatnow prompt.
 140 .PP
 141 The first non-flag argument to
 142 .B prompter
 143 is taken as the name of
 144 the draft file, and subsequent non-flag arguments are ignored.
 145
 146 .SH FILES
 147 .fc ^ ~
 148 .nf
 149 .ta \w'%etcdir%/ExtraBigFileName  'u
 150 ^$HOME/.mmh/profile~^The user profile
 151 ^/tmp/prompter*~^Temporary copy of message
 152 .fi
 153
 154 .SH "PROFILE COMPONENTS"
 155 .fc ^ ~
 156 .nf
 157 .ta 2.4i
 158 .ta \w'ExtraBigProfileName  'u
 159 prompter\-next: The editor to be used on exit from \fBprompter\fP
 160 ^Msg\-Protect:~^To set mode when creating a new draft
 161 .fi
 162
 163 .SH "SEE ALSO"
 164 comp(1), dist(1), forw(1), repl(1), whatnow(1)
 165
 166 .SH DEFAULTS
 167 .nf
 168 .RB ` \-body '
 169 .RB ` \-prepend '
 170 .RB ` \-norapid '
 171 .fi
 172
 173 .SH CONTEXT
 174 None
 175
 176 .SH "HELPFUL HINTS"
 177 The
 178 .B \-noprepend
 179 switch is particularly useful with
 180 .B comp
 181 .BR \-use .
 182 .PP
 183 The user may wish to link
 184 .B prompter
 185 under several names (e.g.,
 186 `rapid') and give appropriate switches in the profile entries
 187 under these names (e.g., `rapid: \-rapid').  This facilitates
 188 invoking prompter differently for different
 189 .B mmh
 190 commands (e.g.,
 191 `forw: \-editor rapid').
 192 .PP
 193 Former
 194 .B mutt
 195 users might find it useful to create a shell script
 196 .B hprompter
 197 containing:
 198 .PP
 199 .RS 5
 200 .nf
 201 prompter \-nobody \-rapid "$1"
 202 vi "$1"
 203 .fi
 204 .RE
 205 .LP
 206 and use that as the default editor for
 207 .B comp
 208 by adding a profile entry like:
 209 .PP
 210 .RS 5
 211 .nf
 212 comp: \-editor hprompter
 213 .fi
 214 .RE