X-Git-Url: http://git.marmaro.de/?a=blobdiff_plain;f=man%2Fdist.man;h=e217f418e3854202242129ddea4fbbd2cd025444;hb=492101aee1185135f239b3aabd5b2494f748c931;hp=d7f929452ee8d49678f79664e8924d4e73f23e49;hpb=3d7993e40a34f52e2b6394c2f64ef0111ab886f7;p=mmh diff --git a/man/dist.man b/man/dist.man index d7f9294..e217f41 100644 --- a/man/dist.man +++ b/man/dist.man @@ -1,8 +1,7 @@ +.TH DIST %manext1% "June 18, 2012" "%nmhversion%" .\" .\" %nmhwarning% -.\" $Id$ .\" -.TH DIST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME dist \- redistribute a message to additional addresses .SH SYNOPSIS @@ -10,11 +9,11 @@ dist \- redistribute a message to additional addresses .na .B dist .RI [ +folder ] -.RI [ msgs ] +.RI [ msg ] .RB [ \-form .IR formfile ] -.RB [ \-annotate " | " \-noannotate ] -.RB [ \-inplace " | " \-noinplace ] +.RB [ \-annotate " | " \-noannotate ] +.RB [ \-inplace " | " \-noinplace ] .RB [ \-draftfolder .IR +folder ] .RB [ \-draftmessage @@ -23,9 +22,21 @@ dist \- redistribute a message to additional addresses .RB [ \-editor .IR editor ] .RB [ \-noedit ] +.RB [ \-width +.IR columns ] +.RB [ \-from +.IR address ] +.RB [ \-to +.IR address ] +.RB [ \-cc +.IR address ] +.RB [ \-fcc +.IR +folder ] .RB [ \-whatnowproc .IR program ] .RB [ \-nowhatnowproc ] +.RB [ \-atfile ] +.RB [ \-noatfile ] .RB [ \-version ] .RB [ \-help ] .ad @@ -41,7 +52,10 @@ The default message form contains the following elements: .PP .RS 5 .nf -%distcomps% +Resent-From: {from switch} or or +Resent-To: {to switch} or blank +Resent-cc: {cc switch} or blank +Resent-fcc: {fcc switch} or blank .fi .RE .PP @@ -52,7 +66,39 @@ will be used instead of this default form. You may specify an alternate forms file with the switch .B \-form .IR formfile . -The form used will be prepended to the message being resent. +Forms are processed via the +.B nmh +template system; see +.IR mh\-format (5) +for details. Components from the redistributed message are available +as standard component escapes in the forms file. +.PP +In addition to the standard +.IR mh\-format (5) +escapes, the following +.I component +escapes are also supported: +.PP +.RS 5 +.nf +.ta \w'Escape 'u +\w'Returns 'u +.I "Escape Returns Description" +fcc string Any folders specified with `\-fcc\ folder' +nmh\-from string Addresses specified with `\-from\ address' +nmh\-to string Addresses specified with `\-to\ address' +nmh\-cc string Addresses specified with `\-cc\ address' +.fi +.RE +.PP +See the +.IR forw (1) +man page for descriptions of the +.BR \-from , +.BR \-to , +.BR \-cc , +and +.B \-fcc +switches. .PP If the draft already exists, .B dist @@ -74,7 +120,7 @@ and will be sent. Also, a .RI \*(lq "Resent\-Fcc: folder" \*(rq will be honored (see -.BR send (1)). +.IR send (1)). Note that with .BR dist , the draft should contain only @@ -83,14 +129,20 @@ fields and no body. The headers and the body of the original message are copied to the draft when the message is sent. Use care in constructing the headers for the redistribution. .PP +Because the draft is minimal, the +.IR prompter (1) +editor is quite useful with +.BR dist . +.PP If the .B \-annotate switch is given, the message being distributed will be annotated with the lines: - - Resent:\ date - Resent:\ addrs - +.RS +Resent:\ date +.br +Resent:\ addrs +.RE where each address list contains as many lines as required. This annotation will be done only if the message is sent directly from .BR dist . @@ -106,12 +158,14 @@ the switch to change this. .PP See -.BR comp (1) +.IR comp (1) for a description of the .B \-editor and .B \-noedit -switches. Note that while in the editor, the message being resent +switches. Note that while in the editor, with +.B \-atfile +and if the current directory is writable, the message being resent is available through a link named \*(lq@\*(rq (assuming the default .IR whatnowproc ). In addition, the actual pathname of the message is @@ -120,6 +174,11 @@ stored in the environment variable and the pathname of the folder containing the message is stored in the environment variable .BR $mhfolder . +The creation of the \*(lq@\*(rq file is controlled via the +.B \-atfile +and +.B \-noatfile +options. .PP The .B \-draftfolder @@ -131,7 +190,7 @@ switches invoke the .B nmh draft folder facility. This is an advanced (and highly useful) feature. Consult the -.BR mh-draft (5) +.IR mh-draft (5) man page for more information. .PP Upon exiting from the editor, @@ -139,7 +198,7 @@ Upon exiting from the editor, will invoke the .B whatnow program. See -.BR whatnow (1) +.IR whatnow (1) for a discussion of available options. The invocation of this program can be inhibited by using the .B \-nowhatnowproc @@ -148,17 +207,15 @@ switch. (In truth of fact, it is the program which starts the initial edit. Hence, .B \-nowhatnowproc will prevent any edit from occurring.) - .SH FILES .fc ^ ~ .nf -.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u +.ta \w'%etcdir%/ExtraBigFileName 'u ^%etcdir%/distcomps~^The standard message skeleton ^or /distcomps~^Rather than the standard skeleton ^$HOME/\&.mh\(ruprofile~^The user profile ^/draft~^The draft file .fi - .SH "PROFILE COMPONENTS" .fc ^ ~ .nf @@ -171,10 +228,13 @@ will prevent any edit from occurring.) ^fileproc:~^Program to refile the message ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions .fi - .SH "SEE ALSO" -comp(1), forw(1), repl(1), send(1), whatnow(1) - +.IR comp (1), +.IR forw (1), +.IR prompter (1), +.IR repl (1), +.IR send (1), +.IR whatnow (1) .SH DEFAULTS .nf .RB ` +folder "' defaults to the current folder" @@ -182,12 +242,11 @@ comp(1), forw(1), repl(1), send(1), whatnow(1) .RB ` \-noannotate ' .RB ` \-nodraftfolder ' .RB ` \-inplace ' +.RB ` \-noatfile ' .fi - .SH CONTEXT If a folder is given, it will become the current folder. The message distributed will become the current message. - .SH HISTORY .B Dist originally used headers of the form @@ -202,7 +261,6 @@ will recognize .RI \*(lq Distribute\-xxx: \*(rq type headers and automatically convert them to .RI \*(lq Resent\-xxx: \*(rq. - .SH BUGS .B Dist does not rigorously check the message being distributed @@ -234,6 +292,3 @@ don't call it since .B comp won't run it. -.PP -If your current working directory is not writable, the link named -\*(lq@\*(rq is not available.