Annotation of 43BSDReno/contrib/mh/doc/forw.me, revision 1.1.1.1

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

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.