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