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

   1 .\"
   2 .\" %nmhwarning%
   3 .\" $Id$
   4 .\"
   5 .\" include the -mh macro file
   6 .so %etcdir%/tmac.h
   7 .\"
   8 .TH DIST %manext1% MH.6.8 [%nmhversion%]
   9 .SH NAME
  10 dist \- redistribute a message to additional addresses
  11 .SH SYNOPSIS
  12 .in +.5i
  13 .ti -.5i
  14 dist
  15 \%[+folder] \%[msg]
  16 \%[\-annotate] \%[\-noannotate]
  17 .br
  18 \%[\-inplace] \%[\-noinplace]
  19 \%[\-form\ formfile]
  20 .br
  21 \%[\-draftfolder\ +folder] \%[\-draftmessage\ msg]
  22 .br
  23 \%[\-nodraftfolder]
  24 \%[\-editor\ editor] \%[\-noedit]
  25 .br
  26 \%[\-whatnowproc\ program] \%[\-nowhatnowproc]
  27 .br
  28 \%[\-version]
  29 \%[\-help]
  30 .in -.5i
  31 .SH DESCRIPTION
  32 \fIDist\fR is similar to \fIforw\fR.  It prepares the specified message
  33 for redistribution to addresses that (presumably) are not on the original
  34 address list.
  35
  36 The default message form contains the following elements:
  37
  38 .nf
  39 .in +.5i
  40 .ne 10
  41 .eo
  42 .so %etcdir%/distcomps
  43 .ec
  44 .in -.5i
  45 .fi
  46
  47 If a file named \*(lqdistcomps\*(rq exists in the user's nmh directory, it
  48 will be used instead of this default form.  You may specify an alternate
  49 forms file with the switch `\-form\ formfile'.  The form used will be
  50 prepended to the message being resent.
  51
  52 If the draft already exists, \fIdist\fR will ask you as to the disposition
  53 of the draft.  A reply of \fBquit\fR will abort \fIdist\fR, leaving the
  54 draft intact; \fBreplace\fR will replace the existing draft with a blank
  55 skeleton; and \fBlist\fR will display the draft.
  56
  57 Only those addresses in \*(lqResent\-To:\*(rq, \*(lqResent\-cc:\*(rq,
  58 and \*(lqResent\-Bcc:\*(rq will be sent.  Also, a
  59 \*(lqResent\-Fcc:\ folder\*(rq will be honored (see \fIsend\fR\0(1)).
  60 Note that with \fIdist\fR, the draft should contain only
  61 \*(lqResent\-xxx:\*(rq fields and no body.  The headers and the body of
  62 the original message are copied to the draft when the message is sent.
  63 Use care in constructing the headers for the redistribution.
  64
  65 If the `\-annotate' switch is given, the  message being distributed will
  66 be annotated with the lines:
  67
  68      Resent:\ date
  69      Resent:\ addrs
  70
  71 where each address list contains as many lines as required.  This
  72 annotation will be done only if the message is sent directly from
  73 \fIdist\fR.  If the message is not sent immediately from \fIdist\fR,
  74 \*(lqcomp \-use\*(rq may be used to re\-edit and send the constructed
  75 message, but the annotations won't take place.  Normally annotations are
  76 done inplace in order to preserve any links to the message.  You may use
  77 the '\-noinplace' switch to change this.
  78
  79 See \fIcomp\fR\0(1) for a description of the `\-editor' and `\-noedit'
  80 switches.  Note that while in the editor, the message being resent
  81 is available through a link named \*(lq@\*(rq (assuming the default
  82 \fIwhatnowproc\fR\0).  In addition, the actual pathname of the message is
  83 stored in the environment variable \fB$editalt\fR, and the pathname of
  84 the folder containing the message is stored in the environment variable
  85 \fB$mhfolder\fR.
  86
  87 The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke
  88 the \fInmh\fR draft folder facility.  This is an advanced (and highly
  89 useful) feature.  Consult the \fImh-draft\fR(5) man page for more
  90 information.
  91
  92 Upon exiting from the editor, \fIdist\fR will invoke the \fIwhatnow\fR
  93 program.  See \fIwhatnow\fR\0(1) for a discussion of available
  94 options.  The invocation of this program can be inhibited by using the
  95 `\-nowhatnowproc' switch.  (In truth of fact, it is the \fIwhatnow\fR
  96 program which starts the initial edit.  Hence, `\-nowhatnowproc' will
  97 prevent any edit from occurring.)
  98 .Fi
  99 ^%etcdir%/distcomps~^The standard message skeleton
 100 ^or <mh\-dir>/distcomps~^Rather than the standard skeleton
 101 ^$HOME/\&.mh\(ruprofile~^The user profile
 102 ^<mh\-dir>/draft~^The draft file
 103 .Pr
 104 ^Path:~^To determine the user's nmh directory
 105 .Ps
 106 ^Current\-Folder:~^To find the default current folder
 107 .Ps
 108 ^Draft\-Folder:~^To find the default draft\-folder
 109 .Ps
 110 ^Editor:~^To override the default editor
 111 .Ps
 112 ^fileproc:~^Program to refile the message
 113 .Ps
 114 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
 115 .Sa
 116 comp(1), forw(1), repl(1), send(1), whatnow(1)
 117 .De
 118 `+folder' defaults to the current folder
 119 .Ds
 120 `msg' defaults to cur
 121 .Ds
 122 `\-noannotate'
 123 .Ds
 124 `\-nodraftfolder'
 125 .Ds
 126 `\-inplace'
 127 .Co
 128
 129 If a folder is given, it will become the current folder.  The message
 130 distributed will become the current message.
 131 .Hi
 132 \fIDist\fR originally used headers of the form \*(lqDistribute\-xxx:\*(rq
 133 instead of \*(lqResent\-xxx:\*(rq.  In order to conform with the ARPA
 134 Internet standard, RFC\-822, the \*(lqResent\-xxx:\*(rq form is now used.
 135 \fIDist\fR will recognize \*(lqDistribute\-xxx:\*(rq type headers and
 136 automatically convert them to \*(lqResent\-xxx:\*(rq.
 137 .Bu
 138 \fIDist\fR does not \fIrigorously\fR check the message being distributed
 139 for adherence to the transport standard, but \fIpost\fR called by
 140 \fIsend\fR does.  The \fIpost\fR program will balk (and rightly so) at
 141 poorly formatted messages, and \fIdist\fR won't correct things for you.
 142
 143 If \fIwhatnowproc\fR is \fIwhatnow\fR, then \fIdist\fR uses a built\-in
 144 \fIwhatnow\fR, it does not actually run the \fIwhatnow\fR program.
 145 Hence, if you define your own \fIwhatnowproc\fR, don't call it
 146 \fIwhatnow\fR since \fIdist\fR won't run it.
 147
 148 If your current working directory is not writable, the link named
 149 \*(lq@\*(rq is not available.
 150 .En