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

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