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

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