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

   1 .TH DIST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   2 .\"
   3 .\" %nmhwarning%
   4 .\"
   5 .SH NAME
   6 dist \- redistribute a message to additional addresses
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B dist
  11 .RI [ +folder ]
  12 .RI [ msg ]
  13 .RB [ \-form
  14 .IR formfile ]
  15 .RB [ \-annotate " | " \-noannotate ]
  16 .RB [ \-inplace " | " \-noinplace ]
  17 .RB [ \-draftfolder
  18 .IR +folder ]
  19 .RB [ \-draftmessage
  20 .IR msg ]
  21 .RB [ \-nodraftfolder ]
  22 .RB [ \-editor
  23 .IR editor ]
  24 .RB [ \-noedit ]
  25 .RB [ \-width
  26 .IR columns ]
  27 .RB [ \-from
  28 .IR address ]
  29 .RB [ \-to
  30 .IR address ]
  31 .RB [ \-cc
  32 .IR address ]
  33 .RB [ \-fcc
  34 .IR +folder ]
  35 .RB [ \-whatnowproc
  36 .IR program ]
  37 .RB [ \-nowhatnowproc ]
  38 .RB [ \-atfile ]
  39 .RB [ \-noatfile ]
  40 .RB [ \-version ]
  41 .RB [ \-help ]
  42 .ad
  43 .SH DESCRIPTION
  44 .B Dist
  45 is similar to
  46 .BR forw .
  47 It prepares the specified message
  48 for redistribution to addresses that (presumably) are not on the original
  49 address list.
  50 .PP
  51 The default message form contains the following elements:
  52 .PP
  53 .RS 5
  54 .nf
  55 Resent-From: {from switch} or <Local-Mailbox> or <username@hostname>
  56 Resent-To: {to switch} or blank
  57 Resent-cc: {cc switch} or blank
  58 Resent-fcc: {fcc switch} or blank
  59 .fi
  60 .RE
  61 .PP
  62 If a file named
  63 .RI \*(lq distcomps \*(rq
  64 exists in the user's nmh directory, it
  65 will be used instead of this default form.  You may specify an alternate
  66 forms file with the switch
  67 .B \-form
  68 .IR formfile .
  69 Forms are processed via the
  70 .B nmh
  71 template system; see
  72 .BR mh\-format (5)
  73 for details.  Components from the redistributed message are available
  74 as standard component escapes in the forms file.
  75 .PP
  76 In addition to the standard
  77 .BR mh\-format (5)
  78 escapes, the following
  79 .I component
  80 escapes are also supported:
  81 .PP
  82 .RS 5
  83 .nf
  84 .ta \w'Escape   'u +\w'Returns  'u
  85 .I "Escape      Returns Description"
  86 fcc     string  Any folders specified with `\-fcc\ folder'
  87 nmh\-from       string  Addresses specified with `\-from\ address'
  88 nmh\-to string  Addresses specified with `\-to\ address'
  89 nmh\-cc string  Addresses specified with `\-cc\ address'
  90 .fi
  91 .RE
  92 .PP
  93 See the
  94 .BR forw (1)
  95 man page for descriptions of the
  96 .BR \-from ,
  97 .BR \-to ,
  98 .BR \-cc ,
  99 and
 100 .B \-fcc
 101 switches.
 102 .PP
 103 If the draft already exists,
 104 .B dist
 105 will ask you as to the disposition of the draft.  A reply of
 106 .B quit
 107 will abort
 108 .BR dist ,
 109 leaving the draft intact;
 110 .B replace
 111 will replace the existing draft with a blank skeleton; and
 112 .B list
 113 will display the draft.
 114 .PP
 115 Only those addresses in
 116 .RI \*(lq Resent\-To: \*(rq,
 117 .RI \*(lq Resent\-cc: \*(rq,
 118 and
 119 .RI \*(lq Resent\-Bcc: \*(rq
 120 will be sent.  Also, a
 121 .RI \*(lq "Resent\-Fcc: folder" \*(rq
 122 will be honored (see
 123 .BR send (1)).
 124 Note that with
 125 .BR dist ,
 126 the draft should contain only
 127 .RI \*(lq Resent\-xxx: \*(rq
 128 fields and no body.  The headers and the body of
 129 the original message are copied to the draft when the message is sent.
 130 Use care in constructing the headers for the redistribution.
 131 .PP
 132 Because the draft is minimal, the
 133 .BR prompter (1)
 134 editor is quite useful with
 135 .BR dist .
 136 .PP
 137 If the
 138 .B \-annotate
 139 switch is given, the  message being distributed will
 140 be annotated with the lines:
 141 .RS
 142 Resent:\ date
 143 .br
 144 Resent:\ addrs
 145 .RE
 146 where each address list contains as many lines as required.  This
 147 annotation will be done only if the message is sent directly from
 148 .BR dist .
 149 If the message is not sent immediately from
 150 .BR dist ,
 151 .RB \*(lq comp
 152 .BR \-use \*(rq
 153 may be used to re\-edit and send the constructed
 154 message, but the annotations won't take place.  Normally annotations are
 155 done inplace in order to preserve any links to the message.  You may use
 156 the
 157 .B \-noinplace
 158 switch to change this.
 159 .PP
 160 See
 161 .BR comp (1)
 162 for a description of the
 163 .B \-editor
 164 and
 165 .B \-noedit
 166 switches.  Note that while in the editor, the message being resent
 167 is available through a link named \*(lq@\*(rq (assuming the default
 168 .IR whatnowproc ).
 169 In addition, the actual pathname of the message is
 170 stored in the environment variable
 171 .BR $editalt ,
 172 and the pathname of
 173 the folder containing the message is stored in the environment variable
 174 .BR $mhfolder .
 175 The creation of the \*(lq@\*(rq file and associated environment variables
 176 can be controlled via the
 177 .B \-atfile
 178 and
 179 .B \-noatfile
 180 options.
 181 .PP
 182 The
 183 .B \-draftfolder
 184 .I +folder
 185 and
 186 .B \-draftmessage
 187 .I msg
 188 switches invoke the
 189 .B nmh
 190 draft folder facility.  This is an advanced (and highly
 191 useful) feature.  Consult the
 192 .BR mh-draft (5)
 193 man page for more information.
 194 .PP
 195 Upon exiting from the editor,
 196 .B dist
 197 will invoke the
 198 .B whatnow
 199 program.  See
 200 .BR whatnow (1)
 201 for a discussion of available options.  The invocation of this
 202 program can be inhibited by using the
 203 .B \-nowhatnowproc
 204 switch.  (In truth of fact, it is the
 205 .B whatnow
 206 program which starts the initial edit.  Hence,
 207 .B \-nowhatnowproc
 208 will prevent any edit from occurring.)
 209 .SH FILES
 210 .fc ^ ~
 211 .nf
 212 .ta \w'%etcdir%/ExtraBigFileName  'u
 213 ^%etcdir%/distcomps~^The standard message skeleton
 214 ^or <mh\-dir>/distcomps~^Rather than the standard skeleton
 215 ^$HOME/\&.mh\(ruprofile~^The user profile
 216 ^<mh\-dir>/draft~^The draft file
 217 .fi
 218 .SH "PROFILE COMPONENTS"
 219 .fc ^ ~
 220 .nf
 221 .ta 2.4i
 222 .ta \w'ExtraBigProfileName  'u
 223 ^Path:~^To determine the user's nmh directory
 224 ^Current\-Folder:~^To find the default current folder
 225 ^Draft\-Folder:~^To find the default draft\-folder
 226 ^Editor:~^To override the default editor
 227 ^fileproc:~^Program to refile the message
 228 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
 229 .fi
 230 .SH "SEE ALSO"
 231 comp(1), forw(1), prompter(1), repl(1), send(1), whatnow(1)
 232 .SH DEFAULTS
 233 .nf
 234 .RB ` +folder "' defaults to the current folder"
 235 .RB ` msg "' defaults to cur"
 236 .RB ` \-noannotate '
 237 .RB ` \-nodraftfolder '
 238 .RB ` \-inplace '
 239 .RB ` \-noatfile '
 240 .fi
 241 .SH CONTEXT
 242 If a folder is given, it will become the current folder.  The message
 243 distributed will become the current message.
 244 .SH HISTORY
 245 .B Dist
 246 originally used headers of the form
 247 .RI \*(lq Distribute\-xxx: \*(rq
 248 instead of
 249 .RI \*(lq Resent\-xxx: \*(rq.
 250 In order to conform with the ARPA Internet standard, RFC\-822, the
 251 .RI \*(lq Resent\-xxx: \*(rq
 252 form is now used.
 253 .B Dist
 254 will recognize
 255 .RI \*(lq Distribute\-xxx: \*(rq
 256 type headers and automatically convert them to
 257 .RI \*(lq Resent\-xxx: \*(rq.
 258 .SH BUGS
 259 .B Dist
 260 does not rigorously check the message being distributed
 261 for adherence to the transport standard, but
 262 .B post
 263 called by
 264 .B send
 265 does.  The
 266 .B post
 267 program will balk (and rightly so) at poorly formatted messages, and
 268 .B dist
 269 won't correct things for you.
 270 .PP
 271 If
 272 .I whatnowproc
 273 is
 274 .BR whatnow ,
 275 then
 276 .B comp
 277 uses a built\-in
 278 .BR whatnow ,
 279 it does not actually run the
 280 .B whatnow
 281 program.
 282 Hence, if you define your own
 283 .IR whatnowproc ,
 284 don't call it
 285 .B whatnow
 286 since
 287 .B comp
 288 won't run it.
 289 .PP
 290 If your current working directory is not writable, the link named
 291 \*(lq@\*(rq is not available.