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 [ \-editor
  17 .IR editor ]
  18 .RB [ \-whatnowproc
  19 .IR program ]
  20 .RB [ \-build ]
  21 .RB [ \-version ]
  22 .RB [ \-help ]
  23 .PP
  24 .HP 5
  25 .B forw
  26 .RI [ +folder ]
  27 .RI [ msgs ]
  28 .RB [ \-digest
  29 .IR list ]
  30 .RB [ \-issue
  31 .IR number ]
  32 .RB [ \-volume
  33 .IR number ]
  34 [other\ switches\ for
  35 .BR forw ]
  36 .RB [ \-version ]
  37 .RB [ \-help ]
  38 .ad
  39 .SH DESCRIPTION
  40 .B Forw
  41 may be used to prepare a message containing other messages.
  42 .PP
  43 It constructs the new message from a forms (components) file, with a
  44 body composed of the message(s) to be forwarded.  An editor is invoked
  45 as in
  46 .BR comp ,
  47 and after editing is complete, the user is prompted
  48 before the message is sent.
  49 .PP
  50 The default message form contains the following elements:
  51 .PP
  52 .RS 5
  53 .nf
  54 %forwcomps%
  55 .fi
  56 .RE
  57 .PP
  58 If a file named
  59 .RI \*(lq forwcomps \*(rq
  60 exists in the user's mmh directory,
  61 it will be used instead of this default form.  You may also specify an
  62 alternate forms file with the switch
  63 .B \-form
  64 .IR formfile .
  65 .PP
  66 If the
  67 .B \-annotate
  68 switch is given, each message being forwarded will
  69 be annotated with the line:
  70 .PP
  71 .RS 5
  72 .nf
  73 Forwarded:\ date
  74 .fi
  75 .RE
  76 .PP
  77 This annotation will be done only if the message is sent directly from
  78 .BR forw .
  79 If the message is not sent immediately from
  80 .BR forw ,
  81 .RB \*(lq comp
  82 .BR \-use \*(rq
  83 may be used to re\-edit and send the constructed
  84 message, but the annotations won't take place.  Annotations
  85 are always done inplace in order to preserve any links to the message.
  86 .PP
  87 See
  88 .BR comp (1)
  89 for a description of the
  90 .B \-editor
  91 switch.
  92 .PP
  93 .B Forw
  94 generates an attachment header field for the messages to be forwarded.
  95 .B Send
  96 will care to encapsulate them using MIME rules.
  97 .PP
  98 To send non-MIME forwarded messages, compose a new message (e.g. with
  99 .B comp )
 100 and read in the output of:
 101 .PP
 102 .RS 5
 103 mhl \-forwall \-form mhl.forward `mhpath
 104 .I MSGS... `
 105 .RE
 106 .PP
 107 The
 108 .B \-editor
 109 .I editor
 110 switch indicates the editor to use for the
 111 initial edit.  Upon exiting from the editor,
 112 .B comp
 113 will invoke the
 114 .B whatnow
 115 program.  See
 116 .BR whatnow (1)
 117 for a discussion of
 118 available options.
 119 .PP
 120 The
 121 .B \-build
 122 switch is intended to be used by the Emacs mh-e interface to
 123 .BR nmh ,
 124 and is only present if
 125 .B nmh
 126 was compiled with support for mh-e.
 127 It causes a file `draft' in the mail storage root
 128 to be created, containing the draft message that would normally be presented
 129 to the user for editing.
 130 No
 131 .B whatnow
 132 program is invoked.
 133 No mail is actually sent. Note that this switch is not guaranteed to
 134 be present or to have the same effects in future versions of
 135 .BR nmh :
 136 it is documented here only for completeness.
 137 .PP
 138 The
 139 .B \-digest
 140 .IR list ,
 141 .B \-issue
 142 .IR number ,
 143 and
 144 .B \-volume
 145 .I number
 146 switches implement a digest facility for
 147 .BR nmh .
 148 Specifying these switches enables and/or overloads the following escapes:
 149 .PP
 150 .RS 5
 151 .nf
 152 .ta \w'Component  'u +\w'Escape  'u +\w'Returns  'u
 153 .I "Type        Escape  Returns Description
 154 component       digest  string  Argument to `\-digest'
 155 function        cur     integer Argument to `\-volume'
 156 function        msg     integer Argument to `\-issue'
 157 .fi
 158 .RE
 159 .PP
 160 Consult the
 161 .I "Advanced Features"
 162 section of the
 163 .B nmh
 164 User's Manual for more information on making digests.
 165
 166 .SH FILES
 167 .fc ^ ~
 168 .nf
 169 .ta \w'%etcdir%/ExtraBigFileName  'u
 170 ^%etcdir%/forwcomps~^The standard message skeleton
 171 ^or $HOME/.mmh/forwcomps~^Rather than the standard skeleton
 172 ^%etcdir%/digestcomps~^The message skeleton if `\-digest' is given
 173 ^or $HOME/.mmh/digestcomps~^Rather than the standard skeleton
 174 ^$HOME/.mmh/profile~^The user profile
 175 ^+drafts~^The draft folder
 176 .fi
 177
 178 .SH "PROFILE COMPONENTS"
 179 .fc ^ ~
 180 .nf
 181 .ta 2.4i
 182 .ta \w'ExtraBigProfileName  'u
 183 ^Path:~^To determine the user's mail storage
 184 ^Current\-Folder:~^To find the default current folder
 185 ^Draft\-Folder:~^To set the default draft\-folder
 186 ^Editor:~^To override the default editor
 187 ^Msg\-Protect:~^To set mode when creating a new message (draft)
 188 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
 189 .fi
 190
 191 .SH "SEE ALSO"
 192 mhbuild(1), comp(1), repl(1), send(1), whatnow(1), mh\-format(5),
 193 .I "Proposed Standard for Message Encapsulation"
 194 (RFC\-934)
 195
 196 .SH DEFAULTS
 197 .nf
 198 .RB ` +folder "' defaults to the current folder"
 199 .RB ` msgs "' defaults to cur"
 200 .RB ` \-noannotate '
 201 .fi
 202
 203 .SH CONTEXT
 204 If a folder is given, it will become the current folder.
 205 The first message forwarded will become the current message.
 206
 207 .SH BUGS
 208 When
 209 .B forw
 210 is told to annotate the messages it forwards, it
 211 doesn't actually annotate them until the draft is successfully sent.
 212 If from the
 213 .IR whatnowproc ,
 214 you
 215 .B push
 216 instead of
 217 .BR send ,
 218 it's possible to confuse
 219 .B forw
 220 by re\-ordering the file (e.g. by using
 221 .RB \*(lq folder
 222 .BR \-pack \*(rq)
 223 before the message is successfully sent.
 224 .B Dist
 225 and
 226 .B repl
 227 don't have this problem.