git.marmaro.de Git - mmh/blob - man/forw.man

   1 .\"
   2 .\" %nmhwarning%
   3 .\" $Id$
   4 .\"
   5 .TH FORW %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   6 .SH NAME
   7 forw \- forward messages
   8 .SH SYNOPSIS
   9 .HP 5
  10 .na
  11 .B forw
  12 .RI [ +folder ]
  13 .RI [ msgs ]
  14 .RB [ \-annotate " | " \-noannotate ]
  15 .RB [ \-form
  16 .IR formfile ]
  17 .RB [ \-format " | " \-noformat ]
  18 .RB [ \-filter
  19 .IR filterfile ]
  20 .RB [ \-inplace " | " \-noinplace ]
  21 .RB [ \-mime " | " \-nomime ]
  22 .RB [ \-draftfolder
  23 .IR +folder ]
  24 .RB [ \-draftmessage
  25 .IR msg ]
  26 .RB [ \-nodraftfolder ]
  27 .RB [ \-editor
  28 .IR editor ]
  29 .RB [ \-noedit ]
  30 .RB [ \-whatnowproc
  31 .IR program ]
  32 .RB [ \-nowhatnowproc ]
  33 .RB [ \-dashstuffing " | " \-nodashstuffing ]
  34 .RB [ \-build ]
  35 .RB [ \-file
  36 .IR msgfile ]
  37 .RB [ \-version ]
  38 .RB [ \-help ]
  39 .PP
  40 .HP 5
  41 .B forw
  42 .RI [ +folder ]
  43 .RI [ msgs ]
  44 .RB [ \-digest
  45 .IR list ]
  46 .RB [ \-issue
  47 .IR number ]
  48 .RB [ \-volume
  49 .IR number ]
  50 [other\ switches\ for\
  51 .BR forw ]
  52 .RB [ \-version ]
  53 .RB [ \-help ]
  54 .ad
  55 .SH DESCRIPTION
  56 .B Forw
  57 may be used to prepare a message containing other messages.
  58 .PP
  59 It constructs the new message from a forms (components) file, with a
  60 body composed of the message(s) to be forwarded.  An editor is invoked
  61 as in
  62 .BR comp ,
  63 and after editing is complete, the user is prompted
  64 before the message is sent.
  65 .PP
  66 The default message form contains the following elements:
  67 .PP
  68 .RS 5
  69 .nf
  70 %forwcomps%
  71 .fi
  72 .RE
  73 .PP
  74 If a file named
  75 .RI \*(lq forwcomps \*(rq
  76 exists in the user's nmh directory,
  77 it will be used instead of this default form.  You may also specify an
  78 alternate forms file with the switch
  79 .B \-form
  80 .IR formfile .
  81 .PP
  82 If the draft already exists,
  83 .B forw
  84 will ask you as to the disposition
  85 of the draft.  A reply of
  86 .B quit
  87 will abort
  88 .BR forw ,
  89 leaving the draft intact;
  90 .B replace
  91 will replace the existing draft with a blank skeleton; and
  92 .B list
  93 will display the draft.
  94 .PP
  95 If the
  96 .B \-annotate
  97 switch is given, each message being forwarded will
  98 be annotated with the lines:
  99
 100      Forwarded:\ date
 101      Forwarded:\ addrs
 102
 103 where each address list contains as many lines as required.  This
 104 annotation will be done only if the message is sent directly from
 105 .BR forw .
 106 If the message is not sent immediately from
 107 .BR forw ,
 108 .RB \*(lq comp
 109 .BR \-use \*(rq
 110 may be used to re\-edit and send the constructed
 111 message, but the annotations won't take place.  Normally annotations
 112 are done inplace in order to preserve any links to the message.  You may
 113 change this by using the
 114 .B \-noinplace
 115 switch.
 116 .PP
 117 See
 118 .BR comp (1)
 119 for a description of the
 120 .B \-editor
 121 and
 122 .B \-noedit
 123 switches.
 124 .PP
 125 Although
 126 .B forw
 127 uses a forms (components) file to direct it how to
 128 construct the beginning of the draft, it uses a message filter file to
 129 direct it as to how each forwarded message should be formatted in the
 130 body of the draft.  The filter file for \fIforw\fR should be a standard
 131 form file for
 132 .BR mhl ,
 133 as
 134 .B forw
 135 will invoke
 136 .B mhl
 137 to filter (re\-format) the forwarded messages prior to being output to
 138 the body of the draft.
 139 .PP
 140 The switches
 141 .BR \-noformat ,
 142 .BR \-format ,
 143 and
 144 .B \-filter
 145 .I filterfile
 146 specify which message filter file to use.
 147 .PP
 148 If
 149 .B \-noformat
 150 is specified (this is the default), then each forwarded
 151 message is output into the draft exactly as it appears with no
 152 .B mhl
 153 filtering.
 154 .PP
 155 If
 156 .B \-format
 157 is specified, then a default message filter file is used.
 158 This default message filter should be adequate for most users.
 159 This default filter
 160 .RI \*(lq mhl.forward \*(rq
 161 is:
 162 .PP
 163 .RS 5
 164 .nf
 165 %mhl_forward%
 166 .fi
 167 .RE
 168 .PP
 169 If a file named
 170 .RI \*(lq mhl.forward \*(rq
 171 exists in the user's nmh
 172 directory, it will be used instead of this form.  You may specify an
 173 alternate message filter file with the switch
 174 .B \-filter
 175 .IR filterfile .
 176 .PP
 177 Each forwarded message is separated with an encapsulation delimiter.
 178 By default, any dashes in the first column of the forwarded messages
 179 will be prepended with `\-\ ' so that when received, the message is
 180 suitable for bursting by
 181 .BR burst .
 182 This follows the Internet RFC\-934 guidelines.  You may use the flag
 183 .B \-nodashstuffing
 184 in order
 185 to suppress this form of quoting to the forwarded messages.
 186 .PP
 187 For users of
 188 .BR prompter ,
 189 by specifying
 190 .BR prompter 's
 191 .B \-prepend
 192 switch in the
 193 .I \&.mh\(ruprofile
 194 file, any commentary text is entered
 195 before the forwarded messages.  (A major win!)
 196 .PP
 197 To use the MIME rules for encapsulation, specify the
 198 .B \-mime
 199 switch. This directs
 200 .B forw
 201 to generate an
 202 .B mhbuild
 203 composition file. Note that
 204 .B nmh
 205 will not invoke
 206 .B mhbuild
 207 automatically, unless you
 208 add this line to your
 209 .I \&.mh\(ruprofile
 210 file:
 211 .PP
 212 .RS 5
 213 .nf
 214 automimeproc: 1
 215 .fi
 216 .RE
 217 .PP
 218 Otherwise, you must specifically give the command
 219 .PP
 220 .RS 5
 221 .nf
 222 What now? mime
 223 .fi
 224 .RE
 225 .PP
 226 prior to sending the draft.
 227 .PP
 228 The
 229 .B \-draftfolder
 230 .I +folder
 231 and
 232 .B \-draftmessage
 233 .I msg
 234 switches invoke the
 235 .B nmh
 236 draft folder facility.  This is an advanced (and highly
 237 useful) feature.  Consult the
 238 .BR mh-draft (5)
 239 man page for more information.
 240 .PP
 241 The
 242 .B \-editor
 243 .I editor
 244 switch indicates the editor to use for the
 245 initial edit.  Upon exiting from the editor,
 246 .B comp
 247 will invoke the
 248 .B whatnow
 249 program.  See
 250 .BR whatnow (1)
 251 for a discussion of
 252 available options.  The invocation of this program can be inhibited
 253 by using the
 254 .B \-nowhatnowproc
 255 switch.  (In truth of fact, it is
 256 the
 257 .I whatnow
 258 program which starts the initial edit.  Hence,
 259 .B \-nowhatnowproc
 260 will prevent any edit from occurring.)
 261 .PP
 262 The
 263 .B \-build
 264 switch is intended to be used by the Emacs mh-e interface to
 265 .BR nmh ,
 266 and is only present if
 267 .B nmh
 268 was compiled with support for mh-e. It implies
 269 .BR \-nowhatnowproc .
 270 It causes a file <mh\-dir>/draft
 271 to be created, containing the draft message that would normally be presented
 272 to the user for editing.
 273 No mail is actually sent. Note that this switch is not guaranteed to
 274 be present or to have the same effects in future versions of
 275 .BR nmh :
 276 it is documented here only for completeness.
 277 .PP
 278 The
 279 .B \-file
 280 .I msgfile
 281 switch specifies the message to be forwarded as an
 282 exact filename rather than as an
 283 .B nmh
 284 folder and message number. It is
 285 intended to be used by the
 286 .B msh
 287 interface to
 288 .BR nmh .
 289 This switch implies
 290 .BR \-noannotate .
 291 The forwarded message is simply
 292 copied verbatim into the draft; the processing implied by
 293 the
 294 .BR \-filter ,
 295 .BR \-mime ,
 296 and
 297 .B \-digest
 298 switches is bypassed, and the usual leading and trailing
 299 'Forwarded Message' delimiters are not added.
 300 The same caveats apply to this option as to the
 301 .B \-build
 302 switch.
 303 .PP
 304 The
 305 .B \-digest
 306 .IR list ,
 307 .B \-issue
 308 .IR number ,
 309 and
 310 .B \-volume
 311 .I number
 312 switches implement a digest facility for
 313 .BR nmh .
 314 Specifying these switches enables and/or overloads the following escapes:
 315 .PP
 316 .RS 5
 317 .nf
 318 .ta \w'Component  'u +\w'Escape  'u +\w'Returns  'u
 319 .I Type Escape  Returns Description
 320 component       digest  string  Argument to `\-digest'
 321 function        cur     integer Argument to `\-volume'
 322 function        msg     integer Argument to `\-issue'
 323 .fi
 324 .RE
 325 .PP
 326 Consult the
 327 .I "Advanced Features"
 328 section of the
 329 .B nmh
 330 User's Manual for more information on making digests.
 331
 332 .SH FILES
 333 .fc ^ ~
 334 .nf
 335 .ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
 336 ^%etcdir%/forwcomps~^The standard message skeleton
 337 ^or <mh\-dir>/forwcomps~^Rather than the standard skeleton
 338 ^%etcdir%/digestcomps~^The message skeleton if `\-digest' is given
 339 ^or <mh\-dir>/digestcomps~^Rather than the standard skeleton
 340 ^%etcdir%/mhl.forward~^The standard message filter
 341 ^or <mh\-dir>/mhl.forward~^Rather than the standard filter
 342 ^$HOME/\&.mh\(ruprofile~^The user profile
 343 ^<mh\-dir>/draft~^The draft file
 344 .fi
 345
 346 .SH "PROFILE COMPONENTS"
 347 .fc ^ ~
 348 .nf
 349 .ta 2.4i
 350 .ta \w'ExtraBigProfileName  'u
 351 ^Path:~^To determine the user's nmh directory
 352 ^Current\-Folder:~^To find the default current folder
 353 ^Draft\-Folder:~^To find the default draft\-folder
 354 ^Editor:~^To override the default editor
 355 ^Msg\-Protect:~^To set mode when creating a new message (draft)
 356 ^fileproc:~^Program to refile the message
 357 ^mhlproc:~^Program to filter messages being forwarded
 358 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
 359 .fi
 360
 361 .SH "SEE ALSO"
 362 mhbuild(1), comp(1), repl(1), send(1), whatnow(1), mh\-format(5),
 363 .I "Proposed Standard for Message Encapsulation"
 364 (RFC\-934)
 365
 366 .SH DEFAULTS
 367 .nf
 368 .RB ` +folder "' defaults to the current folder"
 369 .RB ` msgs "' defaults to cur"
 370 .RB ` \-noannotate '
 371 .RB ` \-nodraftfolder '
 372 .RB ` \-noformat '
 373 .RB ` \-inplace '
 374 .RB ` \-dashstuffing '
 375 .RB ` \-nomime '
 376 .fi
 377
 378 .SH CONTEXT
 379 If a folder is given, it will become the current folder.
 380 The first message forwarded will become the current message.
 381
 382 .SH BUGS
 383 If
 384 .I whatnowproc
 385 is
 386 .BR whatnow ,
 387 then
 388 .B forw
 389 uses a built\-in
 390 .BR whatnow ,
 391 it does not actually run the
 392 .B whatnow
 393 program.
 394 Hence, if you define your own
 395 .IR whatnowproc ,
 396 don't call it
 397 .B whatnow
 398 since
 399 .B forw
 400 won't run it.
 401 .PP
 402 When
 403 .B forw
 404 is told to annotate the messages it forwards, it
 405 doesn't actually annotate them until the draft is successfully sent.
 406 If from the
 407 .IR whatnowproc ,
 408 you
 409 .B push
 410 instead of
 411 .BR send ,
 412 it's possible to confuse
 413 .B forw
 414 by re\-ordering the file (e.g. by using
 415 .RB \*(lq folder
 416 .BR \-pack \*(rq)
 417 before the message is successfully sent.
 418 .B Dist
 419 and
 420 .B repl
 421 don't have this problem.