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