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