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