Man pages: Replaced \*(lq and \*(rq with ` and '.
[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 message being resent
87 is available through a link named `@' (assuming the default
88 .IR whatnowproc ).
89 In addition, the actual pathname of the message is
90 stored in the environment variable
91 .BR $editalt ,
92 and the pathname of
93 the folder containing the message is stored in the environment variable
94 .BR $mhfolder .
95 .PP
96 Consult the
97 .BR mh-draft (7)
98 man page for more information.
99 .PP
100 Upon exiting from the editor,
101 .B dist
102 will invoke the
103 .B whatnow
104 program.  See
105 .BR whatnow (1)
106 for a discussion of available options.
107
108 .SH FILES
109 .fc ^ ~
110 .nf
111 .ta \w'%etcdir%/ExtraBigFileName  'u
112 ^%etcdir%/distcomps~^The standard message skeleton
113 ^or $HOME/.mmh/distcomps~^Rather than the standard skeleton
114 ^$HOME/.mmh/profile~^The user profile
115 ^+drafts~^The draft folder
116 .fi
117
118 .SH "PROFILE COMPONENTS"
119 .fc ^ ~
120 .nf
121 .ta 2.4i
122 .ta \w'ExtraBigProfileName  'u
123 ^Path:~^To determine the user's mail storage
124 ^Current\-Folder:~^To find the default current folder
125 ^Draft\-Folder:~^To set the default draft\-folder
126 ^Editor:~^To override the default editor
127 ^whatnowproc:~^Program to ask the `What now?' questions
128 .fi
129
130 .SH "SEE ALSO"
131 comp(1), forw(1), repl(1), send(1), whatnow(1)
132
133 .SH DEFAULTS
134 .nf
135 .RB ` +folder "' defaults to the current folder"
136 .RB ` msg "' defaults to cur"
137 .RB ` \-noannotate '
138 .fi
139
140 .SH CONTEXT
141 If a folder is given, it will become the current folder.  The message
142 distributed will become the current message.
143
144 .SH HISTORY
145 .B Dist
146 originally used headers of the form
147 .RI ` Distribute\-xxx: '
148 instead of
149 .RI ` Resent\-xxx: '.
150 In order to conform with the ARPA Internet standard, RFC\-822, the
151 .RI ` Resent\-xxx: '
152 form is now used.
153 Since
154 .B mmh
155 .B dist
156 will no longer recognize and convert
157 .RI ` Distribute\-xxx: '
158 type headers.
159
160 .SH BUGS
161 .B Dist
162 does not rigorously check the message being distributed
163 for adherence to the transport standard, but
164 .B post
165 called by
166 .B send
167 does.  The
168 .B post
169 program will balk (and rightly so) at poorly formatted messages, and
170 .B dist
171 won't correct things for you.