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

   1 .\"
   2 .\" %nmhwarning%
   3 .\"
   4 .TH REPL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   5 .SH NAME
   6 repl \- reply to a message
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B repl
  11 .RI [ +folder ]
  12 .RI [ msgs ]
  13 .RB [ \-annotate " | " \-noannotate ]
  14 .RB [ \-group " | " \-nogroup ]
  15 .RB [ \-cc
  16 all/to/cc/me]
  17 .RB [ \-nocc
  18 all/to/cc/me]
  19 .RB [ \-query " | " \-noquery ]
  20 .RB [ \-form
  21 .IR formfile ]
  22 .RB [ \-filter
  23 .IR filterfile
  24 .RB " | " \-nofilter ]
  25 .RB [ \-mime " | " \-nomime ]
  26 .RB [ \-editor
  27 .IR editor ]
  28 .RB [ \-noedit ]
  29 .RB [ \-whatnowproc
  30 .IR program ]
  31 .RB [ \-build ]
  32 .RB [ \-file
  33 .IR msgfile ]
  34 .RB [ \-version ]
  35 .RB [ \-help ]
  36 .ad
  37 .SH DESCRIPTION
  38 .B Repl
  39 may be used to produce a reply to an existing message.
  40 .PP
  41 In its simplest form (with no arguments),
  42 .B repl
  43 will set up a
  44 message\-form skeleton in reply to the current message in the current
  45 folder, and invoke the whatnow shell.
  46 .PP
  47 In order to construct the message draft of the reply,
  48 .B repl
  49 uses
  50 a reply template to guide its actions.  A reply template is simply a
  51 .B mhl
  52 format file (see
  53 .BR mh\-format (5)
  54 for details).
  55 .PP
  56 If the switch
  57 .B \-nogroup
  58 is given (it is on by default), then
  59 .B repl
  60 will use the standard forms file \*(lqreplcomps\*(rq.  This will construct
  61 a draft message that is intended to be sent only to the author of the
  62 message to which you are replying.  If a file named \*(lqreplcomps\*(rq
  63 exists in the user's
  64 .B mmh
  65 directory, it will be used instead of this
  66 default forms file.
  67 .PP
  68 The default reply template \*(lqreplcomps\*(rq will direct
  69 .B repl
  70 to construct the reply message draft as follows:
  71 .PP
  72 .RS 5
  73 .nf
  74 To: <Mail\-Reply\-To> or <Reply\-To> or <From>
  75 Cc: <To> and <Cc> and <personal address>
  76 Fcc: +sent
  77 Subject: Re: <Subject>
  78 In\-Reply\-To: <Message\-Id>
  79 References: <Message\-Id>
  80 Comments: In\-Reply\-To <From> or <apparently from> or <Sender>
  81 .ti +3
  82 message dated <date>
  83 --------
  84 .fi
  85 .RE
  86 .PP
  87 where field names enclosed in angle brackets (<\ >) indicate the
  88 contents of the named field from the message to which the reply is
  89 being made.
  90 .PP
  91 By default, the \*(lqCc:\*(rq field is empty.  You may selectively add
  92 addresses to this default with the
  93 .B \-cc
  94 .I type
  95 switch.  This switch takes an
  96 argument (
  97 .IR all / to / cc / me )
  98 which specifies who gets added to the default
  99 \*(lqCc:\*(rq list of the reply.  You may give this switch multiple times (with
 100 different arguments) if you wish to add multiple types of addresses.
 101 .PP
 102 If the switch
 103 .B \-group
 104 is given, then
 105 .B repl
 106 will use the the
 107 standard forms file \*(lqreplgroupcomps\*(rq.  This will construct a
 108 draft message that is intended as a group or followup reply.  If a file
 109 named \*(lqreplgroupcomps\*(rq exists in the user's mmh directory, it
 110 will be used instead of this default forms file.
 111 .PP
 112 The default group reply template \*(lqreplgroupcomps\*(rq will direct
 113 .B repl
 114 to construct the reply message draft as follows:
 115 .PP
 116 .RS 5
 117 .nf
 118 To: <Mail\-Followup\-To>
 119 Subject: Re: <Subject>
 120 In\-Reply\-To: Message from <From> of <Date>.
 121 .ti +\w'In\-Reply\-To: 'u
 122 <Message\-Id>
 123 --------
 124 .fi
 125 .RE
 126 .PP
 127 or if the field <Mail\-Followup\-To> is not available:
 128 .PP
 129 .RS 5
 130 .nf
 131 To: <Mail\-Reply\-To> or <Reply\-To> or <From>
 132 Cc: <To> and <Cc> and <personal address>
 133 Subject: Re: <Subject>
 134 In\-Reply\-To: Message from <From> of <Date>.
 135 .ti +\w'In\-Reply\-To: 'u
 136 <Message\-Id>
 137 --------
 138 .fi
 139 .RE
 140 .PP
 141 By default, the \*(lqCc:\*(rq contains all the addresses shown.  You may
 142 selectively remove addresses from this default with the
 143 .B \-nocc
 144 .I type
 145 switch.
 146 This switch takes an argument (
 147 .IR all / to / cc / me )
 148 which specifies who gets removed
 149 from the default \*(lqCc:\*(rq list of the reply.  You may give this switch
 150 multiple times (with different arguments) if you wish to remove multiple types
 151 of addresses.
 152 .PP
 153 In any case, you may specify an alternate forms file with the switch
 154 .B \-form
 155 .IR formfile .
 156 .PP
 157 The
 158 .B \-query
 159 switch modifies the action of
 160 .B \-nocc
 161 .I type
 162 switch by
 163 interactively asking you if each address that normally would be placed in
 164 the \*(lqTo:\*(rq and \*(lqCc:\*(rq list should actually be sent a copy.
 165 This is useful for special\-purpose replies.  Note that the position of
 166 the
 167 .B \-cc
 168 and
 169 .B \-nocc
 170 switches, like all other switches which take a
 171 positive and negative form, is important.
 172 .PP
 173 Lines beginning with the fields \*(lqTo:\*(rq, \*(lqCc:\*(rq, and
 174 \*(rqBcc:\*(rq will be standardized and have duplicate addresses removed.
 175 In addition, these fields will be wrapped at a reasonable length.
 176 .PP
 177 See
 178 .BR comp (1)
 179 for a description of the
 180 .B \-editor
 181 and
 182 .B \-noedit
 183 switches.  Note that while in the editor, the message being replied
 184 to is available through a link named \*(lq@\*(rq (assuming the default
 185 .IR whatnowproc ).
 186 In addition, the actual pathname of the message is
 187 stored in the environment variable
 188 .BR $editalt ,
 189 and the pathname of
 190 the folder containing the message is stored in the environment variable
 191 .BR $mhfolder .
 192 .PP
 193 Although
 194 .B repl
 195 uses a forms file to direct it how to construct
 196 the beginning of the draft, it uses a message filter file to direct
 197 it as to how the message to which you are replying should be filtered
 198 (re\-formatted) in the body of the draft.  The filter file for
 199 .B repl
 200 should be a standard form file for
 201 .BR mhl ,
 202 as
 203 .B repl
 204 will invoke
 205 .B mhl
 206 to format the message to which you are replying.
 207 .PP
 208 By default, the original message gets filtered
 209 through a default message filter file and then included into the draft body
 210 as quotation.
 211 This should be adequate for most users.
 212 This default filter
 213 .RI \*(lq mhl.reply \*(rq
 214 is:
 215 .PP
 216 .RS 5
 217 .nf
 218 %mhl_reply%
 219 .fi
 220 .RE
 221 .PP
 222 which outputs each line of the body of the message prefaced with the
 223 \*(lq>\*(rq character and a space.
 224 If a file named
 225 .RI \*(lq mhl.reply \*(rq
 226 exists in the user's
 227 .B mmh
 228 directory,
 229 it will be used instead of this form.
 230 .PP
 231 You may specify an alternate message filter file with the switch
 232 .B \-filter
 233 .IR filterfile .
 234 .PP
 235 Other reply filters are commonly used, such as:
 236 .PP
 237 .RS 5
 238 .nf
 239 :
 240 body:nocomponent,compwidth=9,offset=9
 241 .fi
 242 .RE
 243 .PP
 244 which says to output a blank line and then the body of the message
 245 being replied\-to, indented by one tab\-stop.  Another popular format
 246 is:
 247 .PP
 248 .RS 5
 249 .nf
 250 message-id:nocomponent,\|nonewline,\\
 251 formatfield=\*(lqIn message %{text},\ \*(rq
 252 from:nocomponent,\|formatfield=\*(lq%(decode(friendly{text})) writes:\*(rq
 253 body:component=\*(lq>\*(rq,\|overflowtext=\*(lq>\*(rq,\|overflowoffset=0
 254 .fi
 255 .RE
 256 .PP
 257 This message filter file cites the Message-ID and author of the message
 258 being replied\-to, and then outputs each line of the body prefaced with
 259 the \*(lq>\*(rq character.
 260 .PP
 261 If the switch
 262 .B \-nofilter
 263 is given, then the message
 264 to which you are replying will not be formated and thus not included in
 265 the body of the draft.
 266 (It may be added as MIME attachment with
 267 .B \-mime
 268 though.)
 269 .PP
 270 To MIME-attach the original message, specify the
 271 .B \-mime
 272 switch.
 273 Note: In mmh, the \-mime switch is unrelated to
 274 the \-filter and \-nofilter switches.
 275 It is therefore possible to have the original message quoted in the body
 276 .B and
 277 attached as MIME part.
 278 However, using the \-mime switch is discouraged.
 279 It may get removed in the future.
 280 .PP
 281 If the
 282 .B \-annotate
 283 switch is given, the message being replied\-to will
 284 be annotated with the line:
 285 .PP
 286 .RS 5
 287 .nf
 288 Replied:\ date
 289 .fi
 290 .RE
 291 .PP
 292 The annotation will be done only if the message is sent directly from
 293 .BR repl .
 294 If the message is not sent immediately from
 295 .BR repl ,
 296 .RB \*(lq "comp\ \-use" \*(rq
 297 may be used to re\-edit and send the constructed
 298 message, but the annotations won't take place.  Annotations are always
 299 done inplace in order to preserve any links to the message.
 300 .PP
 301 The default template specifies that a copy of the reply will be
 302 put in
 303 the folder 'sent'.
 304 .PP
 305 To avoid reiteration,
 306 .B repl
 307 strips any leading `Re: ' strings from
 308 the
 309 .I subject
 310 component.
 311 .PP
 312 Consult the
 313 .BR mh-draft (7)
 314 man page for more
 315 information.
 316 .PP
 317 Upon exiting from the editor,
 318 .B repl
 319 will invoke the
 320 .B whatnow
 321 program.  See
 322 .BR whatnow (1)
 323 for a discussion of available
 324 options.
 325 .PP
 326 The
 327 .B \-build
 328 switch is intended to be used by the Emacs mh-e interface
 329 to
 330 .BR nmh ,
 331 and is only present if
 332 .B nmh
 333 was compiled with support
 334 for mh-e.
 335 It causes a file
 336 .I reply (in the mail storage root)
 337 to be created, containing the draft message that would normally be presented
 338 to the user for editing.
 339 No
 340 .B whatnow
 341 programm is invoked.
 342 No mail is actually sent. Note that this switch is not guaranteed to
 343 be present or to have the same effects in future versions of
 344 .BR nmh :
 345 it is documented here only for completeness.
 346 .PP
 347 The
 348 .B \-file
 349 .I msgfile
 350 switch specifies the message to be replied to as an
 351 exact filename rather than as an
 352 .B nmh
 353 folder and message number. It is
 354 intended to be used by the
 355 .B msh
 356 interface to
 357 .BR nmh .
 358 The same caveats apply to this option as to the
 359 .B \-build
 360 switch.
 361
 362 .SH FILES
 363 .fc ^ ~
 364 .nf
 365 .ta \w'%etcdir%/ExtraBigFileName  'u
 366 ^%etcdir%/replcomps~^The standard reply template
 367 ^or $HOME/.mmh/replcomps~^Rather than the standard template
 368 ^%etcdir%/replgroupcomps~^The standard `reply -group' template
 369 ^or $HOME/.mmh/replgroupcomps~^Rather than the standard template
 370 ^%etcdir%/mhl.reply~^The standard message filter
 371 ^or $HOME/.mmh/mhl.reply~^Rather than the standard filter
 372 ^$HOME/.mmh/profile~^The user profile
 373 ^+drafts~^The draft folder
 374 .fi
 375
 376 .SH "PROFILE COMPONENTS"
 377 .fc ^ ~
 378 .nf
 379 .ta 2.4i
 380 .ta \w'ExtraBigProfileName  'u
 381 ^Path:~^To determine the user's mail storage
 382 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
 383 ^Current\-Folder:~^To find the default current folder
 384 ^Draft\-Folder:~^To set the default draft\-folder
 385 ^Editor:~^To override the default editor
 386 ^Msg\-Protect:~^To set mode when creating a new message (draft)
 387 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
 388 .fi
 389
 390 .SH "SEE ALSO"
 391 mhbuild(1), comp(1), forw(1), send(1), whatnow(1), mh\-format(5)
 392
 393 .SH DEFAULTS
 394 .nf
 395 .RB ` +folder "' defaults to the current folder"
 396 .RB ` msg "' defaults to cur"
 397 .RB ` \-nogroup '
 398 .RB ` "\-nocc\ all" "' with `\-nogroup', `\-cc\ all' with `\-group'"
 399 .RB ` \-noannotate '
 400 .RB ` \-nomime '
 401 .RB ` \-noquery '
 402 .fi
 403
 404 .SH CONTEXT
 405 If a folder is given, it will become the current folder.  The message
 406 replied\-to will become the current message.
 407
 408 .SH BUGS
 409 If any addresses occur in the reply template, addresses in the template
 410 that do not contain hosts are defaulted incorrectly.  Instead of using
 411 the localhost for the default,
 412 .B repl
 413 uses the sender's host.
 414 Moral of the story: if you're going to include addresses in a reply
 415 template, include the host portion of the address.
 416 .PP
 417 If your current working directory is not writable, the link named
 418 \*(lq@\*(rq is not available.
 419 .PP
 420 The quotation of the original message does not get transfer-decoded, yet.