X-Git-Url: http://git.marmaro.de/?p=mmh;a=blobdiff_plain;f=man%2Fforw.man1;h=073d904474d49c052e70ada1df45df942969c2f7;hp=356911e6236f4761295c971d5298d786dcf4a262;hb=32b2354dbaf4bf934936eb5b102a4a3d2fdd209a;hpb=c8195849d2e366c569271abb0f5f60f4ebf0b4d0 diff --git a/man/forw.man1 b/man/forw.man1 index 356911e..073d904 100644 --- a/man/forw.man1 +++ b/man/forw.man1 @@ -13,20 +13,12 @@ forw \- forward messages .RB [ \-annotate " | " \-noannotate ] .RB [ \-form .IR formfile ] -.RB [ \-format " | " \-noformat ] -.RB [ \-filter -.IR filterfile ] -.RB [ \-mime " | " \-nomime ] .RB [ \-editor .IR editor ] -.RB [ \-noedit ] .RB [ \-whatnowproc .IR program ] -.RB [ \-nowhatnowproc ] .RB [ \-build ] -.RB [ \-file -.IR msgfile ] -.RB [ \-version ] +.RB [ \-Version ] .RB [ \-help ] .PP .HP 5 @@ -39,9 +31,9 @@ forw \- forward messages .IR number ] .RB [ \-volume .IR number ] -[other\ switches\ for\ +[other\ switches\ for .BR forw ] -.RB [ \-version ] +.RB [ \-Version ] .RB [ \-help ] .ad .SH DESCRIPTION @@ -96,87 +88,22 @@ See .BR comp (1) for a description of the .B \-editor -and -.B \-noedit -switches. -.PP -Although -.B forw -uses a forms (components) file to direct it how to -construct the beginning of the draft, it uses a message filter file to -direct it as to how each forwarded message should be formatted in the -body of the draft. The filter file for \fIforw\fR should be a standard -form file for -.BR mhl , -as -.B forw -will invoke -.B mhl -to filter (re\-format) the forwarded messages prior to being output to -the body of the draft. -.PP -The switches -.BR \-noformat , -.BR \-format , -and -.B \-filter -.I filterfile -specify which message filter file to use. +switch. .PP -If -.B \-noformat -is specified (this is the default), then each forwarded -message is output into the draft exactly as it appears with no -.B mhl -filtering. +.B Forw +generates an attachment header field for the messages to be forwarded. +.B Send +will care to encapsulate them using MIME rules. .PP -If -.B \-format -is specified, then a default message filter file is used. -This default message filter should be adequate for most users. -This default filter -.RI \*(lq mhl.forward \*(rq -is: +To send non-MIME forwarded messages, compose a new message (e.g. with +.B comp ) +and read in the output of: .PP .RS 5 -.nf -%mhl_forward% -.fi +mhl \-forwall \-form mhl.forward `mhpath +.I MSGS... ` .RE .PP -If a file named -.RI \*(lq mhl.forward \*(rq -exists in the user's mmh -directory, it will be used instead of this form. You may specify an -alternate message filter file with the switch -.B \-filter -.IR filterfile . -.PP -Each forwarded message is separated with an encapsulation delimiter. -By default, any dashes in the first column of the forwarded messages -will be prepended with `\-\ ' so that when received, the message is -suitable for bursting by -.BR burst . -This follows the Internet RFC\-934 guidelines. -.PP -For users of -.BR prompter , -by specifying -.BR prompter 's -.B \-prepend -switch in the -.I .mmh/profile -file, any commentary text is entered -before the forwarded messages. (A major win!) -.PP -To use the MIME rules for encapsulation, specify the -.B \-mime -switch. This directs -.B forw -to generate an attachment header field. -.B send -will care for everything else. -.PP The .B \-editor .I editor @@ -188,57 +115,19 @@ will invoke the program. See .BR whatnow (1) for a discussion of -available options. The invocation of this program can be inhibited -by using the -.B \-nowhatnowproc -switch. (In truth of fact, it is -the -.I whatnow -program which starts the initial edit. Hence, -.B \-nowhatnowproc -will prevent any edit from occurring.) +available options. .PP The .B \-build switch is intended to be used by the Emacs mh-e interface to -.BR nmh , -and is only present if -.B nmh -was compiled with support for mh-e. It implies -.BR \-nowhatnowproc . +.BR nmh . It causes a file `draft' in the mail storage root to be created, containing the draft message that would normally be presented to the user for editing. -No mail is actually sent. Note that this switch is not guaranteed to -be present or to have the same effects in future versions of -.BR nmh : -it is documented here only for completeness. -.PP -The -.B \-file -.I msgfile -switch specifies the message to be forwarded as an -exact filename rather than as an -.B nmh -folder and message number. It is -intended to be used by the -.B msh -interface to -.BR nmh . -This switch implies -.BR \-noannotate . -The forwarded message is simply -copied verbatim into the draft; the processing implied by -the -.BR \-filter , -.BR \-mime , -and -.B \-digest -switches is bypassed, and the usual leading and -trailing 'Forwarded Message' delimiters are not added. -The same caveats apply to this option as to the -.B \-build -switch. +No +.B whatnow +program is invoked. +No mail is actually sent. .PP The .B \-digest @@ -255,7 +144,7 @@ Specifying these switches enables and/or overloads the following escapes: .RS 5 .nf .ta \w'Component 'u +\w'Escape 'u +\w'Returns 'u -.I Type Escape Returns Description +.I "Type Escape Returns Description component digest string Argument to `\-digest' function cur integer Argument to `\-volume' function msg integer Argument to `\-issue' @@ -276,8 +165,6 @@ User's Manual for more information on making digests. ^or $HOME/.mmh/forwcomps~^Rather than the standard skeleton ^%etcdir%/digestcomps~^The message skeleton if `\-digest' is given ^or $HOME/.mmh/digestcomps~^Rather than the standard skeleton -^%etcdir%/mhl.forward~^The standard message filter -^or $HOME/.mmh/mhl.forward~^Rather than the standard filter ^$HOME/.mmh/profile~^The user profile ^+drafts~^The draft folder .fi @@ -292,8 +179,6 @@ User's Manual for more information on making digests. ^Draft\-Folder:~^To set the default draft\-folder ^Editor:~^To override the default editor ^Msg\-Protect:~^To set mode when creating a new message (draft) -^fileproc:~^Program to refile the message -^mhlproc:~^Program to filter messages being forwarded ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions .fi @@ -307,8 +192,6 @@ mhbuild(1), comp(1), repl(1), send(1), whatnow(1), mh\-format(5), .RB ` +folder "' defaults to the current folder" .RB ` msgs "' defaults to cur" .RB ` \-noannotate ' -.RB ` \-noformat ' -.RB ` \-nomime ' .fi .SH CONTEXT @@ -316,25 +199,6 @@ If a folder is given, it will become the current folder. The first message forwarded will become the current message. .SH BUGS -If -.I whatnowproc -is -.BR whatnow , -then -.B forw -uses a built\-in -.BR whatnow , -it does not actually run the -.B whatnow -program. -Hence, if you define your own -.IR whatnowproc , -don't call it -.B whatnow -since -.B forw -won't run it. -.PP When .B forw is told to annotate the messages it forwards, it