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 attachment header field.
 187 .B send
 188 will care for everything else.
 189 .PP
 190 The
 191 .B \-editor
 192 .I editor
 193 switch indicates the editor to use for the
 194 initial edit.  Upon exiting from the editor,
 195 .B comp
 196 will invoke the
 197 .B whatnow
 198 program.  See
 199 .BR whatnow (1)
 200 for a discussion of
 201 available options.  The invocation of this program can be inhibited
 202 by using the
 203 .B \-nowhatnowproc
 204 switch.  (In truth of fact, it is
 205 the
 206 .I whatnow
 207 program which starts the initial edit.  Hence,
 208 .B \-nowhatnowproc
 209 will prevent any edit from occurring.)
 210 .PP
 211 The
 212 .B \-build
 213 switch is intended to be used by the Emacs mh-e interface to
 214 .BR nmh ,
 215 and is only present if
 216 .B nmh
 217 was compiled with support for mh-e. It implies
 218 .BR \-nowhatnowproc .
 219 It causes a file `draft' in the mail storage root
 220 to be created, containing the draft message that would normally be presented
 221 to the user for editing.
 222 No mail is actually sent. Note that this switch is not guaranteed to
 223 be present or to have the same effects in future versions of
 224 .BR nmh :
 225 it is documented here only for completeness.
 226 .PP
 227 The
 228 .B \-file
 229 .I msgfile
 230 switch specifies the message to be forwarded as an
 231 exact filename rather than as an
 232 .B nmh
 233 folder and message number. It is
 234 intended to be used by the
 235 .B msh
 236 interface to
 237 .BR nmh .
 238 This switch implies
 239 .BR \-noannotate .
 240 The forwarded message is simply
 241 copied verbatim into the draft; the processing implied by
 242 the
 243 .BR \-filter ,
 244 .BR \-mime ,
 245 and
 246 .B \-digest
 247 switches is bypassed, and the usual leading and
 248 trailing 'Forwarded Message' delimiters are not added.
 249 The same caveats apply to this option as to the
 250 .B \-build
 251 switch.
 252 .PP
 253 The
 254 .B \-digest
 255 .IR list ,
 256 .B \-issue
 257 .IR number ,
 258 and
 259 .B \-volume
 260 .I number
 261 switches implement a digest facility for
 262 .BR nmh .
 263 Specifying these switches enables and/or overloads the following escapes:
 264 .PP
 265 .RS 5
 266 .nf
 267 .ta \w'Component  'u +\w'Escape  'u +\w'Returns  'u
 268 .I Type Escape  Returns Description
 269 component       digest  string  Argument to `\-digest'
 270 function        cur     integer Argument to `\-volume'
 271 function        msg     integer Argument to `\-issue'
 272 .fi
 273 .RE
 274 .PP
 275 Consult the
 276 .I "Advanced Features"
 277 section of the
 278 .B nmh
 279 User's Manual for more information on making digests.
 280
 281 .SH FILES
 282 .fc ^ ~
 283 .nf
 284 .ta \w'%etcdir%/ExtraBigFileName  'u
 285 ^%etcdir%/forwcomps~^The standard message skeleton
 286 ^or $HOME/.mmh/forwcomps~^Rather than the standard skeleton
 287 ^%etcdir%/digestcomps~^The message skeleton if `\-digest' is given
 288 ^or $HOME/.mmh/digestcomps~^Rather than the standard skeleton
 289 ^%etcdir%/mhl.forward~^The standard message filter
 290 ^or $HOME/.mmh/mhl.forward~^Rather than the standard filter
 291 ^$HOME/.mmh/profile~^The user profile
 292 ^+drafts~^The draft folder
 293 .fi
 294
 295 .SH "PROFILE COMPONENTS"
 296 .fc ^ ~
 297 .nf
 298 .ta 2.4i
 299 .ta \w'ExtraBigProfileName  'u
 300 ^Path:~^To determine the user's mail storage
 301 ^Current\-Folder:~^To find the default current folder
 302 ^Draft\-Folder:~^To set the default draft\-folder
 303 ^Editor:~^To override the default editor
 304 ^Msg\-Protect:~^To set mode when creating a new message (draft)
 305 ^fileproc:~^Program to refile the message
 306 ^mhlproc:~^Program to filter messages being forwarded
 307 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
 308 .fi
 309
 310 .SH "SEE ALSO"
 311 mhbuild(1), comp(1), repl(1), send(1), whatnow(1), mh\-format(5),
 312 .I "Proposed Standard for Message Encapsulation"
 313 (RFC\-934)
 314
 315 .SH DEFAULTS
 316 .nf
 317 .RB ` +folder "' defaults to the current folder"
 318 .RB ` msgs "' defaults to cur"
 319 .RB ` \-noannotate '
 320 .RB ` \-noformat '
 321 .RB ` \-inplace '
 322 .RB ` \-dashstuffing '
 323 .RB ` \-nomime '
 324 .fi
 325
 326 .SH CONTEXT
 327 If a folder is given, it will become the current folder.
 328 The first message forwarded will become the current message.
 329
 330 .SH BUGS
 331 If
 332 .I whatnowproc
 333 is
 334 .BR whatnow ,
 335 then
 336 .B forw
 337 uses a built\-in
 338 .BR whatnow ,
 339 it does not actually run the
 340 .B whatnow
 341 program.
 342 Hence, if you define your own
 343 .IR whatnowproc ,
 344 don't call it
 345 .B whatnow
 346 since
 347 .B forw
 348 won't run it.
 349 .PP
 350 When
 351 .B forw
 352 is told to annotate the messages it forwards, it
 353 doesn't actually annotate them until the draft is successfully sent.
 354 If from the
 355 .IR whatnowproc ,
 356 you
 357 .B push
 358 instead of
 359 .BR send ,
 360 it's possible to confuse
 361 .B forw
 362 by re\-ordering the file (e.g. by using
 363 .RB \*(lq folder
 364 .BR \-pack \*(rq)
 365 before the message is successfully sent.
 366 .B Dist
 367 and
 368 .B repl
 369 don't have this problem.