|
|
1.1 root 1: .\" This file is automatically generated. Do not edit!
2: .SC FORW 1
3: .NA
4: forw \- forward messages
5: .SY
6: forw
7: \%[+folder] \%[msgs]
8: \%[\-annotate] \%[\-noannotate]
9: \%[\-draftfolder\ +folder] \%[\-draftmessage\ msg] \%[\-nodraftfolder]
10: \%[\-editor\ editor] \%[\-noedit]
11: \%[\-filter\ filterfile]
12: \%[\-form\ formfile]
13: \%[\-format] \%[\-noformat]
14: \%[\-inplace] \%[\-noinplace]
15: \%[\-whatnowproc\ program] \%[\-nowhatnowproc]
16: \%[\-help]
17:
18: .ti .5i
19: forw
20: \%[+folder] \%[msgs]
21: \%[\-digest\ list] \%[\-issue\ number] \%[\-volume\ number]
22: \%[other\ switches\ for\ \fIforw\fR]
23: \%[\-help]
24: .DE
25: \fIForw\fR may be used to prepare a message containing other
26: messages.
27: It constructs the new message from the components file
28: or `\-form\ formfile' (see \fIcomp\fR\0), with a body composed of the
29: message(s) to be forwarded.
30: An editor is invoked as in \fIcomp\fR,
31: and after editing is complete, the user is prompted before the message
32: is sent.
33:
34: The default message form contains the following elements:
35:
36: .nf
37: .in +.5i
38: .ne 10
39: .\".eo
40: .so /usr/new/lib/mh/forwcomps
41: .\".ec
42: .in -.5i
43: .fi
44:
45: If the file named \*(lqforwcomps\*(rq exists in the user's MH directory,
46: it will be used instead of this form.
47: In either case, the file specified by `\-form\ formfile' will be
48: used if given.
49:
50: If the draft already exists,
51: \fIforw\fR will ask you as to the disposition of the draft.
52: A reply of \fBquit\fR will abort \fIforw\fR, leaving the draft intact;
53: \fBreplace\fR will replace the existing draft with a blank skeleton;
54: and \fBlist\fR will display the draft.
55:
56: If the `\-annotate' switch is given, each message being
57: forwarded will be annotated with the lines
58:
59: Forwarded:\ date
60: Forwarded:\ addrs
61:
62: where each address list contains as many lines as required.
63: This annotation
64: will be done only if the message is sent directly from \fIforw\fR.
65: If the message is not sent immediately from \fIforw\fR,
66: \*(lqcomp\ \-use\*(rq may be used to re\-edit and send the constructed message,
67: but
68: the annotations won't take place.
69: The '\-inplace' switch causes annotation to
70: be done in place in order to preserve links to the annotated message.
71:
72: See \fIcomp\fR\0(1) for a description of the `\-editor' and `\-noedit'
73: switches.
74:
75: Although \fIforw\fR uses the `\-form\ formfile' switch to direct it how to
76: construct the beginning of the draft, the `\-filter\ filterfile',
77: `\-format', and `\-noformat'
78: switches direct \fIforw\fR as to how each forwarded message should be
79: formatted in the body of the draft.
80: If `\-noformat' is specified,
81: then each forwarded message is output exactly as it appears.
82: If `\-format' or `\-filter\ filterfile' is specified,
83: then each forwarded message is filtered (re\-formatted) prior to being
84: output to the body of the draft.
85: The filter file for \fIforw\fR should be a standard form file for
86: \fImhl\fR,
87: as \fIforw\fR will invoke \fImhl\fR to format the forwarded messages.
88: The default message filter (what you get with `\-format') is:
89:
90: .nf
91: .in +.5i
92: .ne 10
93: .\".eo
94: .\".so /usr/new/lib/mh/mhl.forward
95: width=80,overflowtext=,overflowoffset=10
96: leftadjust,compress,compwidth=9
97: From:
98: Date:formatfield="%<(nodate{text})%{text}%|%(putstr(tws{text}))%>"
99: To:
100: cc:
101: Subject:
102: .fl
103: :
104: body:nocomponent,overflowoffset=0,noleftadjust,nocompress
105: .\".ec
106: .in -.5i
107: .fi
108:
109: If the file named \*(lqmhl.forward\*(rq exists in the user's MH directory,
110: it will be used instead of this form.
111: In either case, the file specified by `\-filter\ filterfile' will be
112: used if given.
113: To summarize:
114: `\-noformat' will reproduce each forwarded message exactly,
115: `\-format' will use \fImhl\fR and a default filterfile, \*(lqmhl.forward\*(rq,
116: to format each forwarded message, and
117: `\-filter\ filterfile' will use the named filterfile to format each
118: forwarded message with \fImhl\fR.
119:
120: Each forwarded message is separated with an encapsulation delimiter so that
121: when received, the message is suitable for bursting by \fIburst\fR\0(1).
122:
123: For users of \fIprompter\fR\0(1), by specifying prompter's `-prepend'
124: switch in the \&.mh\(ruprofile file, any commentary text is entered before
125: the forwarded messages. (A major win!)
126:
127: The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke the
128: \fIMH\fR draft folder facility.
129: This is an advanced (and highly useful) feature.
130: Consult the \fBAdvanced Features\fR section of the \fIMH\fR manual for more
131: information.
132:
133: Upon exiting from the editor,
134: \fIforw\fR will invoke the \fIwhatnow\fR program.
135: See \fIwhatnow\fR\0(1) for a discussion of available options.
136: The invocation of this program can be inhibited by using the `\-nowhatnowproc'
137: switch.
138: (In truth of fact,
139: it is the \fIwhatnow\fR program which starts the initial edit.
140: Hence, `\-nowhatnowproc' will prevent any edit from occurring.)
141:
142: The `\-digest\ list', `\-issue\ number', and `\-volume\ number' switches
143: implement a digest facility for \fIMH\fR.
144: See the \fIMH\fR user's manual for more information.
145: .Fi
146: ^/usr/new/lib/mh/forwcomps~^The message skeleton
147: ^or <mh\-dir>/forwcomps~^Rather than the standard skeleton
148: ^/usr/new/lib/mh/digestcomps~^The message skeleton if `\-digest' is given
149: ^or <mh\-dir>/digestcomps~^Rather than the standard skeleton
150: ^/usr/new/lib/mh/mhl.forward~^The message filter
151: ^or <mh\-dir>/mhl.forward~^Rather than the standard filter
152: ^$HOME/\&.mh\(ruprofile~^The user profile
153: ^<mh\-dir>/draft~^The draft file
154: .Pr
155: ^Path:~^To determine the user's MH directory
156: .Ps
157: ^Current\-Folder:~^To find the default current folder
158: .Ps
159: ^Draft\-Folder:~^To find the default draft\-folder
160: .Ps
161: ^Editor:~^To override the default editor
162: .Ps
163: ^Msg\-Protect:~^To set mode when creating a new message (draft)
164: .Ps
165: ^fileproc:~^Program to refile the message
166: .Ps
167: ^mhlproc:~^Program to filter messages being forwarded
168: .Ps
169: ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
170: .Sa
171: \fIProposed Standard for Message Encapsulation\fR (aka RFC\-934),
172: .br
173: comp(1), dist(1), repl(1), send(1), whatnow(1)
174: .De
175: `+folder' defaults to the current folder
176: `msgs' defaults to cur
177: .Ds
178: `\-noannotate'
179: .Ds
180: `\-nodraftfolder'
181: .Ds
182: `\-noformat'
183: .Ds
184: `\-noinplace'
185: .Co
186: If a folder is given, it will become the current folder.
187: The first message forwarded will become the current message.
188: .Bu
189: If \fIwhatnowproc\fR is \fIwhatnow\fR,
190: then \fIforw\fR uses a built\-in \fIwhatnow\fR,
191: it does not actually run the \fIwhatnow\fR program.
192: Hence, if you define your own \fIwhatnowproc\fR,
193: don't call it \fIwhatnow\fR since \fIforw\fR won't run it.
194:
195: When \fIforw\fR is told to annotate the messages it forwards,
196: it doesn't actually annotate them until the draft is successfully sent.
197: If from the \fIwhatnowproc\fR,
198: you \fIpush\fR instead of \fIsend\fR,
199: it's possible to confuse \fIforw\fR by re\-ordering the file
200: (e.g., by using `folder\0\-pack') before the message is successfully sent.
201: \fIDist\fR and \fIrepl\fR don't have this problem.
202: .En
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.