Renames: s/+outbox/+sent/ and s/cc:/Cc:/
[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 lines:
72
73      Resent:\ date
74      Resent:\ addrs
75
76 where each address list contains as many lines as required.  This
77 annotation will be done only if the message is sent directly from
78 .BR dist .
79 If the message is not sent immediately from
80 .BR dist ,
81 .RB \*(lq comp
82 .BR \-use \*(rq
83 may be used to re\-edit and send the constructed
84 message, but the annotations won't take place.  Normally annotations are
85 done inplace in order to preserve any links to the message.  You may use
86 the
87 .B \-noinplace
88 switch to change this.
89 .PP
90 See
91 .BR comp (1)
92 for a description of the
93 .B \-editor
94 and
95 .B \-noedit
96 switches.  Note that while in the editor, the message being resent
97 is available through a link named \*(lq@\*(rq (assuming the default
98 .IR whatnowproc ).
99 In addition, the actual pathname of the message is
100 stored in the environment variable
101 .BR $editalt ,
102 and the pathname of
103 the folder containing the message is stored in the environment variable
104 .BR $mhfolder .
105 .PP
106 Consult the
107 .BR mh-draft (7)
108 man page for more information.
109 .PP
110 Upon exiting from the editor,
111 .B dist
112 will invoke the
113 .B whatnow
114 program.  See
115 .BR whatnow (1)
116 for a discussion of available options.  The invocation of this
117 program can be inhibited by using the
118 .B \-nowhatnowproc
119 switch.  (In truth of fact, it is the
120 .B whatnow
121 program which starts the initial edit.  Hence,
122 .B \-nowhatnowproc
123 will prevent any edit from occurring.)
124
125 .SH FILES
126 .fc ^ ~
127 .nf
128 .ta \w'%etcdir%/ExtraBigFileName  'u
129 ^%etcdir%/distcomps~^The standard message skeleton
130 ^or $HOME/.mmh/distcomps~^Rather than the standard skeleton
131 ^$HOME/.mmh/profile~^The user profile
132 ^+drafts~^The draft folder
133 .fi
134
135 .SH "PROFILE COMPONENTS"
136 .fc ^ ~
137 .nf
138 .ta 2.4i
139 .ta \w'ExtraBigProfileName  'u
140 ^Path:~^To determine the user's mail storage
141 ^Current\-Folder:~^To find the default current folder
142 ^Draft\-Folder:~^To set the default draft\-folder
143 ^Editor:~^To override the default editor
144 ^fileproc:~^Program to refile the message
145 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
146 .fi
147
148 .SH "SEE ALSO"
149 comp(1), forw(1), repl(1), send(1), whatnow(1)
150
151 .SH DEFAULTS
152 .nf
153 .RB ` +folder "' defaults to the current folder"
154 .RB ` msg "' defaults to cur"
155 .RB ` \-noannotate '
156 .RB ` \-inplace '
157 .fi
158
159 .SH CONTEXT
160 If a folder is given, it will become the current folder.  The message
161 distributed will become the current message.
162
163 .SH HISTORY
164 .B Dist
165 originally used headers of the form
166 .RI \*(lq Distribute\-xxx: \*(rq
167 instead of
168 .RI \*(lq Resent\-xxx: \*(rq.
169 In order to conform with the ARPA Internet standard, RFC\-822, the
170 .RI \*(lq Resent\-xxx: \*(rq
171 form is now used.
172 .B Dist
173 will recognize
174 .RI \*(lq Distribute\-xxx: \*(rq
175 type headers and automatically convert them to
176 .RI \*(lq Resent\-xxx: \*(rq.
177
178 .SH BUGS
179 .B Dist
180 does not rigorously check the message being distributed
181 for adherence to the transport standard, but
182 .B post
183 called by
184 .B send
185 does.  The
186 .B post
187 program will balk (and rightly so) at poorly formatted messages, and
188 .B dist
189 won't correct things for you.
190 .PP
191 If
192 .I whatnowproc
193 is
194 .BR whatnow ,
195 then
196 .B comp
197 uses a built\-in
198 .BR whatnow ,
199 it does not actually run the
200 .B whatnow
201 program.
202 Hence, if you define your own
203 .IR whatnowproc ,
204 don't call it
205 .B whatnow
206 since
207 .B comp
208 won't run it.
209 .PP
210 If your current working directory is not writable, the link named
211 \*(lq@\*(rq is not available.