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