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

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