Added test of -nosequence to test-pick.
[mmh] / docs / historical / mh-6.8.5 / doc / dist.me
1 .\"     This file is automatically generated.  Do not edit!
2 .\" @(#)$Id: dist.rf,v 1.5 90/04/05 15:12:30 sources Exp $
3 .SC DIST 1
4 .NA
5 dist \- redistribute a message to additional addresses
6 .SY
7 dist
8 \%[+folder] \%[msg] 
9 \%[\-annotate] \%[\-noannotate] 
10 \%[\-draftfolder\ +folder] \%[\-draftmessage\ msg] \%[\-nodraftfolder]
11 \%[\-editor\ editor] \%[\-noedit]
12 \%[\-form\ formfile] 
13 \%[\-inplace] \%[\-noinplace] 
14 \%[\-whatnowproc\ program] \%[\-nowhatnowproc]
15 \%[\-help]
16 .DE
17 \fIDist\fR is similar to \fIforw\fR.
18 It prepares the specified
19 message for redistribution to addresses that (presumably) are
20 not on the original address list.
21
22 The default message form contains the following elements:
23
24 .nf
25 .in +.5i
26 .ne 10
27 .eo
28 .so /opt/mh-6.8.5/lib/distcomps
29 .ec
30 .in -.5i
31 .fi
32
33 If the file named \*(lqdistcomps\*(rq exists in the user's MH directory,
34 it will be used instead of this form.
35 In either case, the file specified by `\-form\ formfile' will be
36 used if given.
37 The form used will be prepended to the message being resent.
38
39 If the draft already exists,
40 \fIdist\fR will ask you as to the disposition of the draft.
41 A reply of \fBquit\fR will abort \fIdist\fR, leaving the draft intact;
42 \fBreplace\fR will replace the existing draft with a blank skeleton;
43 and \fBlist\fR will display the draft.
44
45 Only those addresses in \*(lqResent\-To:\*(rq, \*(lqResent\-cc:\*(rq, and
46 \*(lqResent\-Bcc:\*(rq will be sent.
47 Also, a \*(lqResent\-Fcc:\ folder\*(rq will be honored (see \fIsend\fR\0(1)).
48 Note that with \fIdist\fR, the draft should contain only 
49 \*(lqResent\-xxx:\*(rq fields and no body.
50 The headers and the body of the original message are copied to the draft when
51 the message is sent.
52 Use care in constructing the headers for the redistribution.
53
54 If the `\-annotate' switch is given, the  message being
55 distributed will be annotated with the lines:
56
57      Resent:\ date
58      Resent:\ addrs
59
60 where each address list contains as many lines as required.
61 This annotation
62 will be done only if the message is sent directly from \fIdist\fR.
63 If the message is not sent immediately from \fIdist\fR,
64 \*(lqcomp \-use\*(rq may be used to re\-edit and send the constructed message,
65 but the annotations won't take place.
66 The '\-inplace' switch causes annotation to
67 be done in place in order to preserve links to the annotated message.
68
69 See \fIcomp\fR\0(1) for a description of the `\-editor' and `\-noedit'
70 switches.
71 Note that while in the editor,
72 the message being resent is available through a link named \*(lq@\*(rq
73 (assuming the default \fIwhatnowproc\fR\0).
74 In addition, the actual pathname of the message is stored in the envariable
75 \fB$editalt\fR,
76 and the pathname of the folder containing the message is stored in the
77 envariable \fB$mhfolder\fR.
78
79 The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke the
80 \fIMH\fR draft folder facility.
81 This is an advanced (and highly useful) feature.
82 Consult the \fBAdvanced Features\fR section of the \fIMH\fR manual for more
83 information.
84
85 Upon exiting from the editor,
86 \fIdist\fR will invoke the \fIwhatnow\fR program.
87 See \fIwhatnow\fR\0(1) for a discussion of available options.
88 The invocation of this program can be inhibited by using the `\-nowhatnowproc'
89 switch.
90 (In truth of fact,
91 it is the \fIwhatnow\fR program which starts the initial edit.
92 Hence, `\-nowhatnowproc' will prevent any edit from occurring.)
93 .Fi
94 ^/opt/mh-6.8.5/lib/distcomps~^The message skeleton
95 ^or <mh\-dir>/distcomps~^Rather than the standard skeleton
96 ^$HOME/\&.mh\(ruprofile~^The user profile
97 ^<mh\-dir>/draft~^The draft file
98 .Pr
99 ^Path:~^To determine the user's MH directory
100 .Ps
101 ^Current\-Folder:~^To find the default current folder
102 .Ps
103 ^Draft\-Folder:~^To find the default draft\-folder
104 .Ps
105 ^Editor:~^To override the default editor
106 .Ps
107 ^fileproc:~^Program to refile the message
108 .Ps
109 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
110 .Sa
111 comp(1), forw(1), repl(1), send(1), whatnow(1)
112 .De
113 `+folder' defaults to the current folder
114 .Ds
115 `msg' defaults to cur
116 .Ds
117 `\-noannotate'
118 .Ds
119 `\-nodraftfolder'
120 .Ds
121 `\-noinplace'
122 .Co
123 If a folder is given, it will become the current folder.
124 The message distributed will become the current message.
125 .Hi
126 \fIDist\fR originally used headers of the form \*(lqDistribute\-xxx:\*(rq
127 instead of \*(lqResent\-xxx:\*(rq.  In order to conform with the
128 ARPA Internet standard, RFC\-822,
129 the \*(lqResent\-xxx:\*(rq form is now used.
130 \fIDist\fR will recognize \*(lqDistribute\-xxx:\*(rq type headers and 
131 automatically convert them to \*(lqResent\-xxx:\*(rq.
132 .Bu
133 \fIDist\fR does not \fIrigorously\fR check the message being
134 distributed for adherence to the transport standard,
135 but \fIpost\fR called by \fIsend\fR does.
136 The \fIpost\fR program will balk (and rightly so) at poorly formatted messages,
137 and \fIdist\fR won't correct things for you.
138
139 If \fIwhatnowproc\fR is \fIwhatnow\fR,
140 then \fIdist\fR uses a built\-in \fIwhatnow\fR,
141 it does not actually run the \fIwhatnow\fR program.
142 Hence, if you define your own \fIwhatnowproc\fR,
143 don't call it \fIwhatnow\fR since \fIdist\fR won't run it.
144
145 If your current working directory is not writable,
146 the link named \*(lq@\*(rq is not available.
147 .En