From: Shantonu Sen Date: Thu, 18 Jan 2001 20:27:34 +0000 (+0000) Subject: prompter-sendfiles X-Git-Tag: RELEASE_1_2~140 X-Git-Url: http://git.marmaro.de/?a=commitdiff_plain;h=1ef7aabbbb72c3e09dfc7db384ac81ab5ac53314;p=mmh prompter-sendfiles --- diff --git a/man/Makefile.in b/man/Makefile.in index a611405..41d3e94 100644 --- a/man/Makefile.in +++ b/man/Makefile.in @@ -128,6 +128,8 @@ man.sed: Makefile echo ' s,%mhl_forward%,,g' >> $@ echo '/%mhl_format%/r $(top_srcdir)/etc/mhl.format' >> $@ echo ' s,%mhl_format%,,g' >> $@ + echo '/%mhl_reply%/r $(top_srcdir)/etc/mhl.reply' >> $@ + echo ' s,%mhl_reply%,,g' >> $@ # ========= INSTALL TARGETS ========= diff --git a/man/prompter.man b/man/prompter.man index 4fae53b..cfe068f 100644 --- a/man/prompter.man +++ b/man/prompter.man @@ -2,115 +2,193 @@ .\" %nmhwarning% .\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" .TH PROMPTER %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME prompter \- prompting editor front-end for nmh .SH SYNOPSIS -.in +.5i -.ti -.5i -prompter -\%[\-erase\ chr] -\%[\-kill\ chr] -\%[\-prepend] \%[\-noprepend] -\%[\-rapid] \%[\-norapid] -\%[\-doteof] \%[\-nodoteof] -file -\%[\-version] -\%[\-help] -.in -.5i +.HP 5 +.B prompter +.RB [ \-erase +.IR chr ] +.RB [ \-kill +.IR chr ] +.RB [ \-prepend " | " \-noprepend ] +.RB [ \-rapid " | " \-norapid ] +.RB [ \-doteof " | " \-nodoteof ] +.I file +.RB [ \-version ] +.RB [ \-help ] .SH DESCRIPTION -\fIPrompter\fR is an editor front\-end for \fInmh\fR which allows rapid +.B Prompter +is an editor front\-end for +.B nmh +which allows rapid composition of messages. This program is not normally invoked directly by users but takes the place of an editor and acts as an editor front\-end. It operates on an RFC\-822 style message draft skeleton specified by -file, normally provided by the nmh commands \fIcomp\fR, \fIdist\fR, -\fIforw\fR, or \fIrepl\fR. - -\fIPrompter\fR is particularly useful when composing messages over slow -network or modem lines. It is an \fInmh\fR program in that it can have +.IR file , +normally provided by the +.B nmh +commands +.BR comp , +.BR dist , +.BR forw , +or +.BR repl . +.PP +.B Prompter +is particularly useful when composing messages over slow +network or modem lines. It is an +.B nmh program in that it can have its own profile entry with switches, but it is not invoked directly by -the user. The commands \fIcomp\fR, \fIdist\fR, \fIforw\fR, and \fIrepl\fR -invoke \fIprompter\fR as an editor, either when invoked with -`\-editor\ prompter', or by the profile entry \*(lqEditor:\ prompter\*(rq, -or when given the command `edit\ prompter' at the \*(lqWhat now?\*(rq prompt. - -For each empty component \fIprompter\fR finds in the draft, the user +the user. The commands +.BR comp , +.BR dist , +.BR forw , +and +.B repl +invoke +.B prompter as an editor, either when invoked with +.B \-editor +.IR prompter , +or by the profile entry \*(lqEditor:\ prompter\*(rq, +or when given the command +.B edit +.B prompter +at the \*(lqWhat now?\*(rq prompt. +.PP +For each empty component +.B prompter finds in the draft, the user is prompted for a response; A will cause the whole component to be left out. Otherwise, a `\\' preceding a will continue the response on the next line, allowing for multiline components. -Continuation lines \fBmust\fR begin with a space or tab. - +Continuation lines +.B must +begin with a space or tab. +.PP Each non\-empty component is copied to the draft and displayed on the terminal. - +.PP The start of the message body is denoted by a blank line or a line of dashes. If the body is non\-empty, the prompt, which isn't written to the file, is - - \*(lq--------Enter additional text\*(rq, - -or (if `\-prepend' was given) - - \*(lq--------Enter initial text\*(rq. - +.PP +.RS 5 +--------Enter additional text +.RE +.PP +or (if +.B \-prepend +was given) +.PP +.RS 5 +--------Enter initial text +.RE +.PP Message\-body typing is terminated with an end\-of\-file (usually -CTRL\-D). With the `\-doteof' switch, a period on a line all by itself +CTRL\-D). With the +.B \-doteof +switch, a period on a line all by itself also signifies end\-of\-file. At this point control is returned to the calling program, where the user is asked \*(lqWhat now?\*(rq. -See \fIwhatnow\fR for the valid options to this query. - -By using the `\-prepend' switch, the user can add type\-in to the +See +.B whatnow (1) +for the valid options to this query. +.PP +By using the +.B \-prepend +switch, the user can add type\-in to the beginning of the message body and have the rest of the body follow. -This is useful for the \fIforw\fR command. - -By using the `\-rapid' switch, if the draft already contains text in +This is useful for the +.B forw +command. +.PP +By using the +.B \-rapid +switch, if the draft already contains text in the message\-body, it is not displayed on the user's terminal. This is useful for low\-speed terminals. - +.PP The line editing characters for kill and erase may be specified by the -user via the arguments `\-kill\ chr' and `\-erase\ chr', where chr may -be a character; or `\\nnn', where \*(lqnnn\*(rq is the octal value for +user via the arguments +.B \-kill +.I chr +and +.B \-erase +.IR chr , +where +.I chr +may be a character; or `\\nnn', where \*(lqnnn\*(rq is the octal value for the character. - +.PP An interrupt (usually CTRL\-C) during component typing will abort -\fIprompter\fR and the \fInmh\fR command that invoked it. An interrupt +.B prompter +and the +.B nmh +command that invoked it. An interrupt during message\-body typing is equivalent to CTRL\-D, for historical -reasons. This means that \fIprompter\fR should finish up and exit. - -The first non\-flag argument to \fIprompter\fR is taken as the name of +reasons. This means that +.B prompter +should finish up and exit. +.PP +The first non\-flag argument to +.B prompter is taken as the name of the draft file, and subsequent non\-flag arguments are ignored. .\" (\fIRepl\fR invokes editors with two file arguments: .\" the draft file name and the replied\-to message file name.) -.Fi + +.SH FILES +.fc ^ ~ +.nf +.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile ^/tmp/prompter*~^Temporary copy of message -.Pr -prompter\-next: To name the editor to be used on exit from \fIprompter\fR -.Ps +.fi + +.SH "PROFILE COMPONENTS" +.fc ^ ~ +.nf +.ta 2.4i +.ta \w'ExtraBigProfileName 'u +prompter\-next: To name the editor to be used on exit from .B prompter ^Msg\-Protect:~^To set mode when creating a new draft -.Sa +.fi + +.SH "SEE ALSO" comp(1), dist(1), forw(1), repl(1), whatnow(1) -.De -`\-prepend' -.Ds -`\-norapid' -.Ds -`\-nodoteof' -.Co + +.SH DEFAULTS +.nf +.RB ` \-prepend ' +.RB ` \-norapid ' +.RB ` \-nodoteof ' +.fi + +.SH CONTEXT None -.Hh -The `\-rapid' option is particularly useful with \fIforw\fP, and -`\-noprepend' is useful with \fIcomp\ \-use\fP. -The user may wish to link \fIprompter\fR under several names (e.g., +.SH "HELPFUL HINTS" +The +.B \-rapid +option is particularly useful with +.BR forw , +and +.B \-noprepend +is useful with +.B comp +.BR \-use . +.PP +The user may wish to link +.B prompter under several names (e.g., \*(lqrapid\*(rq) and give appropriate switches in the profile entries under these names (e.g., \*(lqrapid: -rapid\*(rq). This facilitates -invoking prompter differently for different \fInmh\fP commands (e.g., +invoking prompter differently for different +.B nmh +commands (e.g., \*(lqforw: -editor rapid\*(rq). -.Bu -\fIPrompter\fR uses \fIstdio\fR\0(3), so it will lose if you edit files -with nulls in them. -.En + +.SH BUGS +.B Prompter +uses +.BR stdio (3), +so it will lose if you edit files with nulls in them. diff --git a/man/rcvdist.man b/man/rcvdist.man index 1429ee1..0b04b27 100644 --- a/man/rcvdist.man +++ b/man/rcvdist.man @@ -2,59 +2,80 @@ .\" %nmhwarning% .\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" .TH RCVDIST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME rcvdist \- asynchronously redistribute new mail .SH SYNOPSIS -.in +.5i -.ti -.5i -%libdir%/rcvdist -\%[\-form\ formfile] -.br -\%[switches\ for\ \fIpostproc\fR] -address1\ ... -.br -\%[\-version] -\%[\-help] -.in -.5i +.HP 5 +.B %libdir%/rcvdist +.RB [ \-form +.IR formfile ] +[switches\ for +.IR postproc ] +.I address1 +\&... +.RB [ \-version ] +.RB [ \-help ] .SH DESCRIPTION -The \fIrcvdist\fR program will accept a message on its standard input +The +.B rcvdist +program will accept a message on its standard input and resend a copy of this message to all of the addresses listed on its command line. - -When a message is redistributed with the \fIrcvdist\fR command, the +.PP +When a message is redistributed with the +.B rcvdist +command, the format of the Resent-xxx header fields is controlled by the forms files -"rcvdistcomps". If a file named "rcvdistcomps" exists in the user's nmh +.RI \*(lq rcvdistcomps \*(rq. +If a file named +.RI \*(lq rcvdistcomps \*(rq +exists in the user's nmh directory, it will be used instead of the default one. You may specify -an alternate forms file with the switch `\-form\ formfile'. - -The "rcvdistcomps" file uses the format string facility described in -\fImh\-format\fR(5). In addition to the standard format escapes, -\fIrcvdist\fP also recognizes the following additional \fIcomponent\fR +an alternate forms file with the switch +.B \-form +.IR formfile . +.PP +The +.RI \*(lq rcvdistcomps \*(rq +file uses the format string facility described in +.BR mh\-format (5). +In addition to the standard format escapes, +.B rcvdist +also recognizes the following additional +.I component escape: -.sp 1 -.ne 5 +.PP +.RS 5 .nf .ta \w'Dtimenow 'u +\w'Returns 'u -\fIEscape\fR \fIReturns\fR \fIDescription\fR -addresses string the addresses to distribute to -.re +.I Escape Returns Description +addresses string the addresses to distribute to .fi - -By default, \fIrcvdist\fR uses the program \fIpost\fR(8) to do the actual +.RE +.PP +By default, +.B rcvdist +uses the program +.B post +to do the actual delivery of the message, although this can be changed by defining the -\fIpostproc\fR profile component. -.Fi +.I postproc +profile component. + +.SH FILES +.fc ^ ~ +.nf +.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^%etcdir%/rcvdistcomps~^Default message skeleton ^or /rcvdistcomps~^Rather than standard message skeleton ^%etcdir%/mts.conf~^nmh mts configuration file ^$HOME/\&.maildelivery~^The file controlling local delivery ^%etcdir%/maildelivery~^Rather than the standard file -.Sa +.fi + +.SH "SEE ALSO" rcvpack(1), rcvstore(1), rcvtty(1), mh\-format(5), slocal(1) -.Bu + +.SH BUGS Only two return codes are meaningful, others should be. -.En diff --git a/man/rcvpack.man b/man/rcvpack.man index 1dc7731..6716230 100644 --- a/man/rcvpack.man +++ b/man/rcvpack.man @@ -2,44 +2,56 @@ .\" %nmhwarning% .\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" .TH RCVPACK %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME rcvpack \- append message to file .SH SYNOPSIS -.in +.5i -.ti -.5i -%libdir%/rcvpack -file -\%[-mbox] \%[-mmdf] -.br -\%[\-version] -\%[\-help] -.in -.5i +.HP 5 +.B %libdir%/rcvpack +.I file +.RB [ \-mbox ] +.RB [ \-mmdf ] +.RB [ \-version ] +.RB [ \-help ] .SH DESCRIPTION -The \fIrcvpack\fR program will append a copy of the message to the file +The +.B rcvpack +program will append a copy of the message to the file listed on its command line. - -If the `-mbox' switch is given (the default), then the messages are +.PP +If the +.B \-mbox +switch is given (the default), then the messages are separated using mbox (uucp) style delimiters. This is the format used by most mail clients (elm, mailx, etc.). - -If the `-mmdf' switch is given, then the messages are separated by +.PP +If the +.B \-mmdf +switch is given, then the messages are separated by mmdf style delimiters. Each message in the file is separated by four CTRL\-A's and a newline. - -\fIrcvpack\fR will correctly lock and unlock the file to serialize -access to the file, when running multiple copies of \fIrcvpack\fR. - -In general, its use is obsoleted by the \*(lqfile\*(rq action of -\fIslocal\fR, although it might still have occasional uses in various +.PP +.B rcvpack +will correctly lock and unlock the file to serialize +access to the file, when running multiple copies of +.B rcvpack . +.PP +In general, its use is obsoleted by the +.B file +action of +.BR slocal , +although it might still have occasional uses in various shell scripts. -.Fi + +.SH FILES +.fc ^ ~ +.nf +.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^%etcdir%/mts.conf~^nmh mts configuration file -.Sa +.fi + +.SH "SEE ALSO" rcvdist(1), rcvstore(1), rcvtty(1), slocal(1) -.Bu + +.SH BUGS Only two return codes are meaningful, others should be. -.En diff --git a/man/rcvstore.man b/man/rcvstore.man index b0cf252..1d1f3e1 100644 --- a/man/rcvstore.man +++ b/man/rcvstore.man @@ -2,99 +2,142 @@ .\" %nmhwarning% .\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" .TH RCVSTORE %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME rcvstore \- asynchronously incorporate mail into a folder .SH SYNOPSIS -.in +.5i -.ti -.5i -%libdir%/rcvstore -\%[+folder] -.br -\%[\-create] \%[\-nocreate] -\%[\-unseen] \%[\-nounseen] -.br -\%[\-zero] \%[\-nozero] -\%[\-public] \%[\-nopublic] -.br -\%[\-sequence\ name\ ...] -\%[\-version] -\%[\-help] -.in -.5i +.HP 5 +.B %libdir%/rcvstore +.RI [ +folder ] +.RB [ \-create " | " \-nocreate ] +.RB [ \-unseen " | " \-nounseen ] +.RB [ \-zero " | " \-nozero ] +.RB [ \-sequence +.I name +\&...] +.RB [ \-public " | " \-nopublic ] +.RB [ \-version ] +.RB [ \-help ] .SH DESCRIPTION -\fIRcvstore\fR incorporates a message from the standard input into an -\fInmh\fR folder. This command is typically used in conjunction with -mail filtering programs such as \fIslocal\fR and \fIprocmail\fR, to -filter your mail into different folders. - -You may specify which folder to use with `+folder'. If no folder is -specified, \fIrcvstore\fP will use the folder given by a non\-empty +.B Rcvstore +incorporates a message from the standard input into an +.B nmh +folder. This command is typically used in conjunction with +mail filtering programs such as +.B slocal +and +.BR procmail , +to filter your mail into different folders. +.PP +You may specify which folder to use with +.IR +folder . +If no folder is specified, +.B rcvstore +will use the folder given by a non\-empty \*(lqInbox:\*(rq entry in the user's profile, else it will use the folder named \*(lqinbox\*(rq. - -If the switch `\-create' is given (it is the default) and if the specified +.PP +If the switch +.B \-create +is given (it is the default) and if the specified (or default) folder does not exist, then it will be created. You may -disable this with the `\-nocreate' option. In this case \fIrcvstore\fP +disable this with the +.B \-nocreate +option. In this case +.B rcvstore will exit if the specified folder does not exist. - +.PP When the new message is incorporated into the folder, it is assigned the next highest number for that folder. - -\fIRcvstore\fR will incorporate anything except zero length messages -into the user's nmh folder. It will not change the message in any +.PP +.B Rcvstore +will incorporate anything except zero length messages +into the user's +.B nmh +folder. It will not change the message in any way. - +.PP If the user's profile contains a \*(lqMsg\-Protect: nnn\*(rq entry, it will be used as the protection on the newly created message, otherwise -the \fInmh\fR default of 0644 will be used. For all subsequent operations +the +.B nmh +default of 0644 will be used. For all subsequent operations on this message, this initially assigned protection will be preserved. - -If the switch `\-unseen' is given (it is on by default), and if the +.PP +If the switch +.B \-unseen +is given (it is on by default), and if the profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty, then -\fIrcvstore\fR will add the newly incorporated message to each sequence -named by this profile entry. You may use the switch `\-nounseen' to -disable this. These sequences will not be zero'ed by \fIrcvstore\fR +.B rcvstore +will add the newly incorporated message to each sequence +named by this profile entry. You may use the switch +.B \-nounseen +to disable this. These sequences will not be zero'ed by +.B rcvstore prior to adding the new message. - +.PP Furthermore, the incoming message may be added to additional sequences -as they arrive by the use of the `\-sequence' switch. As with the -commands \fIpick\fP and \fImark\fP, you may also use the switches -`\-zero' and `\-nozero' to specify whether to zero old sequences or not. -Similarly, use of the `\-public' and `\-nopublic switches may be used +as they arrive by the use of the +.B \-sequence +switch. As with the +commands +.B pick +and +.BR mark , +you may also use the switches +.B \-zero +and +.B \-nozero +to specify whether to zero old sequences or not. +Similarly, use of the +.B \-public +and +.B \-nopublic +switches may be used to force these sequences to be public or private sequences. -.Fi +.SH FILES +.fc ^ ~ +.nf +.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile -.Pr +.fi + +.SH "PROFILE COMPONENTS" +.fc ^ ~ +.nf +.ta 2.4i +.ta \w'ExtraBigProfileName 'u ^Path:~^To determine the user's nmh directory -.Ps ^Folder\-Protect:~^To set mode when creating a new folder -.Ps ^Inbox:~^To find the default inbox -.Ps ^Msg\-Protect:~^To set mode when creating a new message -.Ps ^Unseen\-Sequence:~^To name sequences denoting unseen messages -.Sa +.fi + +.SH "SEE ALSO" rcvdist(1), rcvpack(1), rcvtty(1), mh\-sequence(5) -.De -`+folder' defaults to \*(lqInbox\*(rq profile entry -.Ds -`\-create' -.Ds -`\-unseen' -.Ds -`\-nozero' -.Co + +.SH DEFAULTS +.nf +.RB ` +folder "' defaults to \*(lqInbox\*(rq profile entry" +.RB ` \-create ' +.RB ` \-unseen ' +.RB ` \-nozero ' +.fi + +.SH CONTEXT No context changes will be attempted, with the exception of sequence manipulation. -.Bu -If you use the \*(lqUnseen\-Sequence\*(rq profile entry, \fIrcvstore\fP -could try to update the context while another \fInmh\fP process + +.SH BUGS +If you use the \*(lqUnseen\-Sequence\*(rq profile entry, +.B rcvstore +could try to update the context while another +.B nmh +process is also trying to do so. This can cause the context to become -corrupted. To avoid this, do not use \fIrcvstore\fP if you use the +corrupted. To avoid this, do not use +.B rcvstore +if you use the \*(lqUnseen\-Sequence\*(rq profile entry. -.En diff --git a/man/rcvtty.man b/man/rcvtty.man index 712f1e2..fbdfa9b 100644 --- a/man/rcvtty.man +++ b/man/rcvtty.man @@ -2,83 +2,123 @@ .\" %nmhwarning% .\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" .TH RCVTTY %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME rcvtty \- report new mail .SH SYNOPSIS -.in +.5i -.ti -.5i -%libdir%/rcvtty -\%[command] -.br -\%[\-form\ formatfile] -\%[\-format\ string] -\%[\-width\ columns] -.br -\%[\-bell] \%[\-nobell] -\%[\-newline] -\%[\-nonewline] -\%[\-biff] -.br -\%[\-version] -\%[\-help] -.in -.5i +.HP 5 +.B %libdir%/rcvtty +.RI [ command ] +.RB [ \-form +.IR formatfile ] +.RB [ \-format +.IR string ] +.RB [ \-width +.IR columns ] +.RB [ \-bell " | " \-nobell ] +.RB [ \-newline " | " \-nonewline ] +.RB [ \-biff ] +.RB [ \-version ] +.RB [ \-help ] .SH DESCRIPTION -The \fIrcvtty\fR can be used to report new mail. It is used primarily -in conjunction with mail filtering agents such as \fIslocal\fP or -\fIprocmail\fP. - -The \fIrcvtty\fR program executes the named command with the message as +The +.B rcvtty +can be used to report new mail. It is used primarily +in conjunction with mail filtering agents such as +.B slocal +or +.BR procmail . +.PP +The +.B rcvtty +program executes the named command with the message as its standard input, and writes the resulting output on your terminal. - -Alternately, if no command is specified (or is bogus), then \fIrcvtty\fR +.PP +Alternately, if no command is specified (or is bogus), then +.B rcvtty will instead write a one\-line scan listing. The default output format of this scan listing may be overridden by using either the -`\-form\ formatfile' or `\-format\ string' option, similar to the -equivalent options for \fIscan\fP and \fIinc\fP. -See \fImh\-format\fP(5) for details. - +.B \-form +.I formatfile +or +.B \-format +.I string +option, similar to the +equivalent options for +.B scan +and +.BR inc . +See +.BR mh\-format (5) +for details. +.PP A newline is output before the message output, and the terminal bell is -rung after the output. The `\-nonewline' and `\-nobell' options will +rung after the output. The +.B \-nonewline +and +.B \-nobell +options will inhibit these functions. - -The switch `\-width\ columns' may be given to specify the width of +.PP +The switch +.B \-width +.I columns +may be given to specify the width of the scan line. The default is to use the width of the terminal. - +.PP In addition to the standard format escapes described in -\fImh\-format\fR(5), \fIrcvtty\fR also recognizes the following additional -\fIcomponent\fR escapes: -.sp 1 -.ne 5 +.BR mh\-format (5), +.B rcvtty +also recognizes the following additional +.I component +escapes: +.PP +.RS 5 .nf .ta \w'Dtimenow 'u +\w'Returns 'u -\fIEscape\fR \fIReturns\fR \fIDescription\fR +Escape Returns Description body string the (compressed) first part of the body dtimenow date the current date folder string the name of the current folder -.re .fi - -By default, \fIrcvtty\fP will send its output to every terminal on the +.RE +.PP +By default, +.B rcvtty +will send its output to every terminal on the local machine that is owned by current user, and that has given write -permission as granted by the command \fImesg\fP\0(1). If the option -`\-biff' is given, then \fIrcvtty\fP will obey the notification status -set by the command \fIbiff\fP\0(1) instead. -.Fi +permission as granted by the command +.BR mesg (1). +If the option +.B \-biff +is given, then +.B rcvtty +will obey the notification status +set by the command +.BR biff (1) +instead. + +.SH FILES +.fc ^ ~ +.nf +.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^%etcdir%/mts.conf~^nmh mts configuration file ^$HOME/\&.maildelivery~^The file controlling local delivery ^%etcdir%/maildelivery~^Rather than the standard file -.De -`\-width' defaults to the width of the terminal -.Ds -`\-newline' -.Ds -`\-bell' -.Sa +.fi + +.SH CONTEXT +None + +.SH DEFAULTS +.nf +.RB ` \-width "' defaults to the width of the terminal" +.RB ` \-newline ' +.RB ` \-bell ' +.fi + +.SH "SEE ALSO" rcvdist(1), rcvpack(1), rcvstore(1), mh\-format(5), slocal(1) -.Bu + +.SH BUGS Only two return codes are meaningful, others should be. -.En diff --git a/man/refile.man b/man/refile.man index 9eb0da5..40cf94e 100644 --- a/man/refile.man +++ b/man/refile.man @@ -2,36 +2,37 @@ .\" %nmhwarning% .\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" .TH REFILE %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME refile \- file message in other folders .SH SYNOPSIS -.in +.5i -.ti -.5i -refile -\%[msgs] -\%[\-draft] -\%[\-link] \%[\-nolink] -.br -\%[\-preserve] \%[\-nopreserve] -\%[\-unlink] \%[\-nounlink] -.br -\%[\-src\ +folder] -\%[\-file\ file] -\%[\-rmmproc program] -.br -\%[\-normmproc] -+folder1 ... -\%[\-version] -\%[\-help] -.in -.5i +.HP 5 +.B refile +.RI [ msgs ] +.RB [ \-draft ] +.RB [ \-link " | " \-nolink ] +.RB [ \-preserve " | " \-nopreserve ] +.RB [ \-unlink " | " \-nounlink ] +.RB [ \-src +.IR +folder ] +.RB [ \-file +.IR file ] +.RB [ \-rmmproc +.IR program ] +.RB [ \-normmproc ] +.I +folder1 +\&... +.RB [ \-version ] +.RB [ \-help ] .SH DESCRIPTION -\fIRefile\fR moves (\fImv\fR\0(1)) or links (\fIln\fR\0(1)) messages +.B Refile +moves (see +.BR mv (1)) +or links (see +.BR ln (1)) +messages from a source folder into one or more destination folders. - +.PP If you think of a message as a sheet of paper, this operation is not unlike filing the sheet of paper (or copies) in file cabinet folders. When a message is filed, it is linked into the destination folder(s) @@ -40,104 +41,192 @@ folders are all on the same file system, multiple filing causes little storage overhead. This facility provides a good way to cross\-file or multiply\-index messages. For example, if a message is received from Jones about the ARPA Map Project, the command - - refile\0cur\0+jones\0+Map - +.PP +.RS 5 +refile\0cur\0+jones\0+Map +.RE +.PP would allow the message to be found in either of the two folders `jones' or `Map'. - -You may specify the source folder using `\-src\ +folder'. If this is +.PP +You may specify the source folder using +.B \-src +.IR +folder . +If this is not given, the current folder is used by default. If no message is specified, then `cur' is used by default. - -The option `\-file\ file' directs \fIrefile\fR to use the specified file +.PP +The option +.B \-file +.I file +directs +.B refile +to use the specified file as the source message to be filed, rather than a message from a folder. Note that the file should be a validly formatted message, just like -any other \fInmh\fR message. It should \fBNOT\fR be in mail drop format -(to convert a file in mail drop format to a folder of \fInmh\fR messages, -see \fIinc\fR\0(1)). - -If a destination folder doesn't exist, \fIrefile\fR will ask if you want +any other +.B nmh +message. It should +.B NOT +be in mail drop format +(to convert a file in mail drop format to a folder of +.B nmh +messages, +see +.BR inc (1)). +.PP +If a destination folder doesn't exist, +.B refile +will ask if you want to create it. A negative response will abort the file operation. If the -standard input for \fIrefile\fR is \fInot\fR a tty, then \fIrefile\fR +standard input for +.B refile +is +.B not +a tty, then +.B refile will not ask any questions and will proceed as if the user answered \*(lqyes\*(rq to all questions. - -The option `\-link' preserves the source folder copy of the message (i.e., -it does a \fIln\fR(1) rather than a \fImv\fR(1)), whereas, `\-nolink' +.PP +The option +.B \-link +preserves the source folder copy of the message (i.e., +it does a +.BR ln (1) +rather than a +.BR mv (1)), +whereas, +.B \-nolink (the default) deletes the filed messages from the source folder. - +.PP Normally when a message is refiled, for each destination folder it is assigned the number which is one above the current highest message -number in that folder. Use of the `\-preserve' switch will override +number in that folder. Use of the +.B \-preserv +switch will override this message renaming, and try to preserve the number of the message. -If a conflict for a particular folder occurs when using the `\-preserve' -switch, then \fIrefile\fR will use the next available message number +If a conflict for a particular folder occurs when using the +.B \-preserve +switch, then +.B refile +will use the next available message number which is above the message number you wish to preserve. - -If `\-link' is not specified (or `\-nolink' is specified), the filed +.PP +If +.B \-link +is not specified (or +.B \-nolink +is specified), the filed messages will be removed from the source folder. The default is to remove these messages by renaming them with a site-dependent prefix (usually a comma). Such files will then need to be removed in some manner after a certain amount of time. Many sites arrange for -\fIcron\fR\0(8) to remove these files once a day, so check with your +.B cron +to remove these files once a day, so check with your system administrator. - -Alternately, if you wish for \fIrefile\fR to really remove the files +.PP +Alternately, if you wish for +.B refile +to really remove the files representing these messages from the source folder, you can use the -`-unlink' switch (not to be confused with the -link switch). But +.B -unlink +switch (not to be confused with the +.B \-link +switch). But messages removed by this method cannot be later recovered. - -.ne 4 +.PP If you prefer a more sophisticated method of `removing' the messages -from the source folder, you can define the \fIrmmproc\fR profile +from the source folder, you can define the +.B rmmproc +profile component. For example, you can add a profile component such as - - rmmproc: /home/coleman/bin/rmm_msgs - -then \fIrefile\fR will instead call the named program or script to +.PP +.RS 5 +rmmproc: /home/coleman/bin/rmm_msgs +.RE +.PP +then +.B refile +will instead call the named program or script to handle the message files. - -The user may specify `\-rmmproc program' on the command line to -override this profile specification. The `-normmproc' option forces +.PP +The user may specify +.B \-rmmproc +.I program +on the command line to +override this profile specification. The +.B \-normmproc +option forces the message files to be deleted by renaming or unlinking them as described above. - -The `\-draft' switch tells \fIrefile\fR to file the /draft. -.Fi +.PP +The +.B \-draft +switch tells +.B refile +to file the /draft. + +.SH FILES +.fc ^ ~ +.nf +.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile -.Pr +.fi + +.SH "PROFILE COMPONENTS" +.fc ^ ~ +.nf +.ta 2.4i +.ta \w'ExtraBigProfileName 'u ^Path:~^To determine the user's nmh directory -.Ps ^Current\-Folder:~^To find the default current folder -.Ps ^Folder\-Protect:~^To set mode when creating a new folder -.Ps ^rmmproc:~^Program to delete the message -.Sa +.fi + +.SH "SEE ALSO" folder(1), rmf(1), rmm(1) -.De -`\-src\ +folder' defaults to the current folder -.Ds -`msgs' defaults to cur -.Ds -`\-nolink' -.Ds -`\-nounlink' -.Ds -`\-nopreserve' -.Co -If `\-src\ +folder' is given, it will become the current folder. -If neither `\-link' nor `all' is specified, the current message in the + +.SH DEFAULTS +.nf +.RB ` "\-src\ +folder" "' defaults to the current folder" +.RB ` msgs "' defaults to cur" +.RB ` \-nolink ' +.RB ` \-nounlink ' +.RB ` \-nopreserve ' +.fi + +.SH CONTEXT +If +.B \-src +.I +folder +is given, it will become the current folder. +If neither +.B \-link +nor `all' is specified, the current message in the source folder will be set to the last message specified; otherwise, the current message won't be changed. - -If the Previous\-Sequence profile entry is set, in addition to defining -the named sequences from the source folder, \fIrefile\fR will also define -those sequences for the destination folders. See \fImh\-sequence\fR\0(5) +.PP +If the \*(lqPrevious\-Sequence\*(rq profile entry is set, in addition to defining +the named sequences from the source folder, +.B refile +will also define +those sequences for the destination folders. See +.B mh\-sequence (5) for information concerning the previous sequence. -.Bu -Since \fIrefile\fR uses your \fIrmmproc\fP to delete the message, -the \fIrmmproc\fP must \fBNOT\fP call \fIrefile\fP without specifying -`\-normmproc', or you will create an infinite loop. -.En + +.SH BUGS +Since +.B refile +uses your +.I rmmproc +to delete the message, +the +.I rmmproc +must +.B NOT +call +.B refile +without specifying +.BR \-normmproc , +or you will create an infinite loop. diff --git a/man/repl.man b/man/repl.man index 20c149d..4320922 100644 --- a/man/repl.man +++ b/man/repl.man @@ -2,293 +2,456 @@ .\" %nmhwarning% .\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" .TH REPL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME repl \- reply to a message .SH SYNOPSIS -.in +.5i -.ti -.5i -repl -\%[+folder] \%[msg] -.br -\%[\-group] \%[\-nogroup] -\%[\-annotate] \%[\-noannotate] -.br -\%[\-cc\ all/to/cc/me] \%[\-nocc\ all/to/cc/me] -.br -\%[\-query] \%[\-noquery] -\%[\-form\ formfile] -.br -\%[\-format] \%[\-noformat] -\%[\-filter\ filterfile] -.br -\%[\-inplace] \%[\-noinplace] -\%[\-mime] \%[\-nomime] -.br -\%[\-fcc\ +folder] -\%[\-width\ columns] -.br -\%[\-draftfolder\ +folder] \%[\-draftmessage\ msg] -.br -\%[\-nodraftfolder] -\%[\-editor\ editor] \%[\-noedit] -.br -\%[\-whatnowproc\ program] \%[\-nowhatnowproc] -.br -\%[\-build] -\%[-file msgfile] -.br -\%[\-version] -\%[\-help] -.in -.5i +.HP 5 +.B repl +.RI [ +folder ] +.RI [ msgs ] +.RB [ \-annotate " | " \-noannotate ] +.RB [ \-group " | " \-nogroup ] +.RB [ \-cc +all/to/cc/me] +.RB [ \-nocc +all/to/cc/me] +.RB [ \-query " | " \-noquery ] +.RB [ \-form +.IR formfile ] +.RB [ \-format " | " \-noformat ] +.RB [ \-filter +.IR filterfile ] +.RB [ \-inplace " | " \-noinplace ] +.RB [ \-mime " | " \-nomime ] +.RB [ \-fcc +.IR +folder ] +.RB [ \-width +.IR columns ] +.RB [ \-draftfolder +.IR +folder ] +.RB [ \-draftmessage +.IR msg ] +.RB [ \-nodraftfolder ] +.RB [ \-editor +.IR editor ] +.RB [ \-noedit ] +.RB [ \-whatnowproc +.IR program ] +.RB [ \-nowhatnowproc ] +.RB [ \-build ] +.RB [ \-file +.IR msgfile ] +.RB [ \-version ] +.RB [ \-help ] .SH DESCRIPTION -\fIRepl\fR may be used to produce a reply to an existing message. - -In its simplest form (with no arguments), \fIrepl\fR will set up a +.B Repl +may be used to produce a reply to an existing message. +.PP +In its simplest form (with no arguments), +.B repl +will set up a message\-form skeleton in reply to the current message in the current folder, and invoke the whatnow shell. - -In order to construct the message draft of the reply, \fIrepl\fR uses +.PP +In order to construct the message draft of the reply, +.B repl +uses a reply template to guide its actions. A reply template is simply a -\fImhl\fR format file (see \fImh\-format\fR\0(5) for details). - -If the switch `\-nogroup' is given (it is on by default), then \fIrepl\fR +.B mhl +format file (see +.BR mh\-format (5) +for details). +.PP +If the switch +.B \-nogroup +is given (it is on by default), then +.B repl will use the standard forms file \*(lqreplcomps\*(rq. This will construct a draft message that is intended to be sent only to the author of the message to which you are replying. If a file named \*(lqreplcomps\*(rq -exists in the user's nmh directory, it will be used instead of this +exists in the user's +.B nmh +directory, it will be used instead of this default forms file. - -The default reply template \*(lqreplcomps\*(rq will direct \fIrepl\fR +.PP +The default reply template \*(lqreplcomps\*(rq will direct +.B repl to construct the reply message draft as follows: - +.PP +.RS 5 .nf -.in 1i To: or or cc: and and Subject: Re: In\-Reply\-To: Your message of . .ti +\w'In\-Reply\-To: 'u -.in .5i +-------- .fi - +.RE +.PP where field names enclosed in angle brackets (<\ >) indicate the contents of the named field from the message to which the reply is being made. - +.PP By default, the \*(lqcc:\*(rq field is empty. You may selectively add -addresses to this default with the `\-cc\ type' switch. This switch takes an -argument (all/to/cc/me) which specifies who gets added to the default +addresses to this default with the +.B \-cc +.I type +switch. This switch takes an +argument ( +.IR all / to / cc / me ) +which specifies who gets added to the default \*(lqcc:\*(rq list of the reply. You may give this switch multiple times (with different arguments) if you wish to add multiple types of addresses. - -If the switch `\-group' is given, then \fIrepl\fR will use the the +.PP +If the switch +.B \-group +is given, then +.B repl +will use the the standard forms file \*(lqreplgroupcomps\*(rq. This will construct a draft message that is intended as a group or followup reply. If a file named \*(lqreplgroupcomps\*(rq exists in the user's nmh directory, it will be used instead of this default forms file. - +.PP The default group reply template \*(lqreplgroupcomps\*(rq will direct -\fIrepl\fR to construct the reply message draft as follows: - +.B repl +to construct the reply message draft as follows: +.PP +.RS 5 .nf -.in 1i To: Subject: Re: In\-Reply\-To: Message from of . .ti +\w'In\-Reply\-To: 'u -.in .5i +-------- .fi - +.RE +.PP or if the field is not available: - +.PP +.RS 5 .nf -.in 1i To: or or cc: and and Subject: Re: In\-Reply\-To: Message from of . .ti +\w'In\-Reply\-To: 'u -.in .5i +-------- .fi - +.RE +.PP By default, the \*(lqcc:\*(rq contains all the addresses shown. You may -selectively remove addresses from this default with the `\-nocc\ type' switch. -This switch takes an argument (all/to/cc/me) which specifies who gets removed +selectively remove addresses from this default with the +.B \-nocc +.I type +switch. +This switch takes an argument ( +.IR all / to / cc / me ) +which specifies who gets removed from the default \*(lqcc:\*(rq list of the reply. You may give this switch multiple times (with different arguments) if you wish to remove multiple types of addresses. - +.PP In any case, you may specify an alternate forms file with the switch -`\-form\ formfile'. - -The `\-query' switch modifies the action of `\-nocc\ type' switch by +.B \-form +.IR formfile . +.PP +The +.B \-query +switch modifies the action of +.B \-nocc +.I type +switch by interactively asking you if each address that normally would be placed in the \*(lqTo:\*(rq and \*(lqcc:\*(rq list should actually be sent a copy. This is useful for special\-purpose replies. Note that the position of -the `\-cc' and `\-nocc' switches, like all other switches which take a +the +.B \-cc +and +.B \-nocc +switches, like all other switches which take a positive and negative form, is important. - +.PP Lines beginning with the fields \*(lqTo:\*(rq, \*(lqcc:\*(rq, and \*(rqBcc:\*(rq will be standardized and have duplicate addresses removed. -In addition, the `\-width\ columns' switch will guide \fIrepl\fR's +In addition, the +.B \-width +.I columns +switch will guide +.BR repl 's formatting of these fields. - -If the draft already exists, \fIrepl\fR will ask you as to the disposition -of the draft. A reply of \fBquit\fR will abort \fIrepl\fR, leaving the -draft intact; \fBreplace\fR will replace the existing draft with a blank -skeleton; and \fBlist\fR will display the draft. - -See \fIcomp\fR\0(1) for a description of the `\-editor' and `\-noedit' +.PP +If the draft already exists, +.B repl +will ask you as to the disposition +of the draft. A reply of +.B quit +will abort +.BR repl , +leaving the +draft intact; +.B replace +will replace the existing draft with a blank +skeleton; and +.B list +will display the draft. +.PP +See +.BR comp (1) +for a description of the +.B \-editor +and +.B \-noedit switches. Note that while in the editor, the message being replied to is available through a link named \*(lq@\*(rq (assuming the default -\fIwhatnowproc\fR\0). In addition, the actual pathname of the message is -stored in the environment variable \fB$editalt\fR, and the pathname of +.IR whatnowproc ). +In addition, the actual pathname of the message is +stored in the environment variable +.BR $editalt , +and the pathname of the folder containing the message is stored in the environment variable -\fB$mhfolder\fR. - -Although \fIrepl\fR uses a forms file to direct it how to construct +.BR $mhfolder . +.PP +Although +.B repl +uses a forms file to direct it how to construct the beginning of the draft, it uses a message filter file to direct it as to how the message to which you are replying should be filtered -(re\-formatted) in the body of the draft. The filter file for \fIrepl\fR -should be a standard form file for \fImhl\fR, as \fIrepl\fR will invoke -\fImhl\fR to format the message to which you are replying. - -The switches `\-noformat', `\-format', and `\-filter\ filterfile' specify +(re\-formatted) in the body of the draft. The filter file for +.B repl +should be a standard form file for +.BR mhl , +as +.B repl +will invoke +.B mhl +to format the message to which you are replying. +.PP +The switches +.BR \-noformat , +.BR \-format , +and +.B \-filter +.I filterfile +specify which message filter file to use. - -If the switch `\-noformat' is given (it is the default), then the message +.PP +If the switch +.B \-noformat +is given (it is the default), then the message to which you are replying is not included in the body of the draft. - -If the switch `\-format' is given, then a default message filter file +.PP +If the switch +.B \-format +is given, then a default message filter file is used. This default message filter should be adequate for most users. -This default filter \*(lqmhl.reply\*(rq is: - +This default filter +.RI \*(lq mhl.reply \*(rq +is: +.PP +.RS 5 .nf -.in +.5i -.ne 10 -.eo -.so %etcdir%/mhl.reply -.ec -.in -.5i +%mhl_reply% .fi - +.RE +.PP which outputs each line of the body of the message prefaced with the \*(lq>\*(rq character and a space. - -If a file named \*(lqmhl.reply\*(rq exists in the user's nmh directory, +.PP +If a file named +.RI \*(lq mhl.reply \*(rq +exists in the user's +.B nmh +directory, it will be used instead of this form. You may specify an alternate -message filter file with the switch `\-filter\ filterfile'. - +message filter file with the switch +.B \-filter +.IR filterfile . +.PP Other reply filters are commonly used, such as: - +.PP +.RS 5 .nf -.in +.5i : body:nocomponent,compwidth=9,offset=9 -.in -.5i .fi - +.RE +.PP which says to output a blank line and then the body of the message being replied\-to, indented by one tab\-stop. Another popular format is: - +.PP +.RS 5 .nf -.in +.5i -.ie n \{ message-id:nocomponent,\|nonewline,\\ -formatfield=\*(lqIn message %{text},\ \*(rq \} -.el message-id:nocomponent,\|nonewline,\|formatfield=\*(lqIn message %{text},\ \*(rq +formatfield=\*(lqIn message %{text},\ \*(rq from:nocomponent,\|formatfield=\*(lq%(friendly{text}) writes:\*(rq body:component=\*(lq>\*(rq,\|overflowtext=\*(lq>\*(rq,\|overflowoffset=0 -.in -.5i .fi - +.RE +.PP This message filter file cites the Message-ID and author of the message being replied\-to, and then outputs each line of the body prefaced with the \*(lq>\*(rq character. - -To use the MIME rules for encapsulation, specify the `\-mime' switch. -This directs \fIreply\fR to generate an \fImhbuild\fR composition file. -Note that nmh will not invoke \fImhbuild\fR automatically, unless you -add this line to your \&.mh\(ruprofile file: -.sp -.in +.5i +.PP +To use the MIME rules for encapsulation, specify the +.B \-mime +switch. +This directs +.B repl +to generate an +.B mhbuild +composition file. +Note that +.B nmh +will not invoke +.B mhbuild +automatically, unless you +add this line to your +.I \&.mh\(ruprofile +file: +.PP +.RS 5 automimeproc: 1 -.in -.5i -.sp +.RE +.PP Otherwise, you must specifically give the command -.sp -.in +.5i +.PP +.RS 5 What now? mime -.in -.5i -.sp +.RE +.PP prior to sending the draft. - -If the `\-annotate' switch is given, the message being replied\-to will +.PP +If the +.B \-annotate +switch is given, the message being replied\-to will be annotated with the lines - - Replied:\ date - Replied:\ addrs - +.PP +.RS 5 +Replied:\ date +Replied:\ addrs +.RE +.PP where the address list contains one line for each addressee. The annotation will be done only if the message is sent directly from -\fIrepl\fR. If the message is not sent immediately from \fIrepl\fR, -\*(lqcomp\ \-use\*(rq may be used to re\-edit and send the constructed +.BR repl . +If the message is not sent immediately from +.BR repl , +.RB \*(lq "comp\ \-use" \*(rq +may be used to re\-edit and send the constructed message, but the annotations won't take place. Normally annotations are done inplace in order to preserve any links to the message. You may use -the `\-noinplace' switch to change this. - -The `\-fcc\ +folder' switch can be used to automatically specify a folder -to receive Fcc:s. More than one folder, each preceded by `\-fcc' can +the +.B \-noinplace +switch to change this. +.PP +The +.B \-fcc +.I +folder +switch can be used to automatically specify a folder +to receive Fcc:s. More than one folder, each preceded by +.B \-fcc +can be named. - -In addition to the standard \fImh\-format\fR\0(5) escapes, \fIrepl\fR -also recognizes the following additional \fIcomponent\fR escape: -.sp 1 +.PP +In addition to the standard +.BR mh\-format (5) +escapes, +.B repl +also recognizes the following additional +.I component +escape: +.PP +.RS 5 .nf .ta \w'Escape 'u +\w'Returns 'u -\fIEscape\fR \fIReturns\fR \fIDescription\fR -\fIfcc\fR string Any folders specified with `\-fcc\ folder' -.re +.I Escape Returns Description +fcc string Any folders specified with `\-fcc\ folder' .fi - -To avoid reiteration, \fIrepl\fR strips any leading `Re: ' strings from -the \fIsubject\fR component. - -The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke -the \fInmh\fR draft folder facility. This is an advanced (and highly -useful) feature. Consult the \fImh-draft\fR(5) man page for more +.RE +.PP +To avoid reiteration, +.B repl +strips any leading `Re: ' strings from +the +.I subject +component. +.PP +The +.B \-draftfolder +.I +folder +and +.B \-draftmessage +.I msg +switches invoke +the +.B nmh +draft folder facility. This is an advanced (and highly +useful) feature. Consult the +.BR mh-draft (5) +man page for more information. - -Upon exiting from the editor, \fIrepl\fR will invoke the \fIwhatnow\fR -program. See \fIwhatnow\fR\0(1) for a discussion of available +.PP +Upon exiting from the editor, +.B repl +will invoke the +.B whatnow +program. See +.BR whatnow (1) +for a discussion of available options. The invocation of this program can be inhibited by using the -`\-nowhatnowproc' switch. (In truth of fact, it is the \fIwhatnow\fR -program which starts the initial edit. Hence, `\-nowhatnowproc' will +.B \-nowhatnowproc +switch. (In truth of fact, it is the +.B whatnow +program which starts the initial edit. Hence, +.B \-nowhatnowproc +will prevent any edit from occurring.) - -The `\-build' switch is intended to be used by the Emacs mh-e interface -to \fInmh\fR, and is only present if \fInmh\fR was compiled with support -for mh-e. It implies `\-nowhatnowproc'. It causes a file /reply +.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 . +It causes a file +.I /reply 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 \fInmh\fR: +be present or to have the same effects in future versions of +.BR nmh : it is documented here only for completeness. - -The `\-file\ msgfile' switch specifies the message to be replied to as an -exact filename rather than as an \fInmh\fR folder and message number. It is -intended to be used by the \fImsh\fR\0(1) interface to \fInmh\fR. -The same caveats apply to this option as to the `\-build' switch. - -.Fi +.PP +The +.B \-file +.I msgfile +switch specifies the message to be replied to 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 . +The same caveats apply to this option as to the +.B \-build +switch. + +.SH FILES +.fc ^ ~ +.nf +.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^%etcdir%/replcomps~^The standard reply template ^or /replcomps~^Rather than the standard template ^%etcdir%/replgroupcomps~^The standard `reply -group' template @@ -297,66 +460,79 @@ The same caveats apply to this option as to the `\-build' switch. ^or /mhl.reply~^Rather than the standard filter ^$HOME/\&.mh\(ruprofile~^The user profile ^/draft~^The draft file -.Pr +.fi + +.SH "PROFILE COMPONENTS" +.fc ^ ~ +.nf +.ta 2.4i +.ta \w'ExtraBigProfileName 'u ^Path:~^To determine the user's nmh directory -.Ps ^Alternate\-Mailboxes:~^To determine the user's mailboxes -.Ps ^Current\-Folder:~^To find the default current folder -.Ps ^Draft\-Folder:~^To find the default draft\-folder -.Ps ^Editor:~^To override the default editor -.Ps ^Msg\-Protect:~^To set mode when creating a new message (draft) -.Ps ^fileproc:~^Program to refile the message -.Ps ^mhlproc:~^Program to filter message being replied\-to -.Ps ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions -.Sa +.fi + +.SH "SEE ALSO" mhbuild(1), comp(1), forw(1), send(1), whatnow(1), mh\-format(5) -.De -`+folder' defaults to the current folder -.Ds -`msg' defaults to cur -.Ds -`\-nogroup' -.Ds -`\-nocc\ all' with `\-nogroup', `\-cc\ all' with `\-group' -.Ds -`\-noannotate' -.Ds -`\-nodraftfolder' -.Ds -`\-noformat' -.Ds -`\-inplace' -.Ds -`\-nomime' -.Ds -`\-noquery' -.Ds -`\-width\ 72' -.Co + +.SH DEFAULTS +.nf +.RB ` +folder "' defaults to the current folder" +.RB ` msg "' defaults to cur" +.RB ` \-nogroup ' +.RB ` "\-nocc\ all" "' with `\-nogroup', `\-cc\ all' with `\-group'" +.RB ` \-noannotate ' +.RB ` \-nodraftfolder ' +.RB ` \-noformat ' +.RB ` \-inplace ' +.RB ` \-nomime ' +.RB ` \-noquery ' +.RB ` "\-width\ 72" ' +.fi + +.SH CONTEXT If a folder is given, it will become the current folder. The message replied\-to will become the current message. -.Bu + +.SH BUGS If any addresses occur in the reply template, addresses in the template that do not contain hosts are defaulted incorrectly. Instead of using -the localhost for the default, \fIrepl\fR uses the sender's host. +the localhost for the default, +.B repl +uses the sender's host. Moral of the story: if you're going to include addresses in a reply template, include the host portion of the address. - -The `\-width columns' switch is only used to do address-folding; other +.PP +The +.B \-width +.I columns +switch is only used to do address-folding; other headers are not line\-wrapped. - -If \fIwhatnowproc\fR is \fIwhatnow\fR, then \fIrepl\fR uses a built\-in -\fIwhatnow\fR, it does not actually run the \fIwhatnow\fR program. -Hence, if you define your own \fIwhatnowproc\fR, don't call it -\fIwhatnow\fR since \fIrepl\fR won't run it. - +.PP +If +.I whatnowproc +is +.BR whatnow , +then +.B repl +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 repl +won't run it. +.PP If your current working directory is not writable, the link named \*(lq@\*(rq is not available. -.En diff --git a/man/rmf.man b/man/rmf.man index 9c282c4..8a15be6 100644 --- a/man/rmf.man +++ b/man/rmf.man @@ -2,69 +2,98 @@ .\" %nmhwarning% .\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" .TH RMF %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME rmf \- remove an nmh folder .SH SYNOPSIS -.in +.5i -.ti -.5i -rmf -\%[+folder] -\%[\-interactive] \%[\-nointeractive] -.br -\%[\-version] -\%[\-help] -.in -.5i +.HP 5 +.B rmf +.RI [ +folder ] +.RB [ \-interactive " | " \-nointeractive ] +.RB [ \-version ] +.RB [ \-help ] .SH DESCRIPTION -\fIRmf\fR removes all of the messages (files) within the specified +.B Rmf +removes all of the messages (files) within the specified (or default) folder, and then removes the folder (directory) itself. - +.PP If there are any files within the folder which are not a part of -\fInmh\fR, they will \fInot\fR be removed, and an error will be produced. -If the folder is given explicitly or the `\-nointeractive' option is +.BR nmh , +they will +.B not +be removed, and an error will be produced. +If the folder is given explicitly or the +.B \-nointeractive +option is given, then the folder will be removed without confirmation. Otherwise, -the user will be asked for confirmation. If \fIrmf\fR can't find the +the user will be asked for confirmation. If +.B rmf +can't find the current folder, for some reason, the folder to be removed defaults to `+inbox' (unless overridden by user's profile entry \*(lqInbox\*(rq) with confirmation. - +.PP If the folder being removed is a subfolder, the parent folder will become -the new current folder, and \fIrmf\fR will produce a message telling the +the new current folder, and +.B rmf +will produce a message telling the user this has happened. This provides an easy mechanism for selecting a set of messages, operating on the list, then removing the list and returning to the current folder from which the list was extracted. - -If \fIrmf\fR is used on a read\-only folder, it will delete all the +.PP +If +.B rmf +s used on a read\-only folder, it will delete all the (private) sequences -(i.e., \*(lqatr\-\fIseq\fR\-\fIfolder\fR\*(rq entries) for this folder +(i.e., +.RI \*(lqatr\- seq \- folder \*(rq +entries) for this folder from your context without affecting the folder itself. - -\fIRmf\fR irreversibly deletes messages that don't have other links, so +.PP +.B Rmf +irreversibly deletes messages that don't have other links, so use it with caution. -.Fi + +.SH FILES +.fc ^ ~ +.nf +.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile -.Pr +.fi + +.SH "PROFILE COMPONENTS" +.fc ^ ~ +.nf +.ta 2.4i +.ta \w'ExtraBigProfileName 'u ^Path:~^To determine the user's nmh directory -.Ps ^Current\-Folder:~^To find the default current folder -.Ps ^Inbox:~^To find the default inbox -.Sa +.fi + +.SH "SEE ALSO" rmm(1) -.De -`+folder' defaults to the current folder, usually with confirmation -.Ds -`\-interactive' if +folder' not given, `\-nointeractive' otherwise -.Co -\fIRmf\fR will set the current folder to the parent folder if a + +.SH DEFAULTS +.nf +.RB ` +folder "' defaults to the current folder, usually with confirmation" +.RB ` \-interactive "' if +folder' not given, `\-nointeractive' otherwise" +.fi + +.SH CONTEXT +.B Rmf +will set the current folder to the parent folder if a subfolder is removed; or if the current folder is removed, it will make \*(lqinbox\*(rq current. Otherwise, it doesn't change the current folder or message. -.Bu -Although intuitively one would suspect that \fIrmf\fR works recursively, + +.SH BUGS +Although intuitively one would suspect that +.B rmf +works recursively, it does not. Hence if you have a sub\-folder within a folder, in order -to \fIrmf\fR the parent, you must first \fIrmf\fR each of the children. -.En +to +.B rmf +the parent, you must first +.B rmf +each of the children. diff --git a/man/rmm.man b/man/rmm.man index 967f9fb..21b3ea8 100644 --- a/man/rmm.man +++ b/man/rmm.man @@ -2,75 +2,117 @@ .\" %nmhwarning% .\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" .TH RMM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME rmm \- remove messages .SH SYNOPSIS -.in +.5i -.ti -.5i -rmm -\%[+folder] \%[msgs] -\%[\-unlink] \%[\-nounlink] -.br -\%[\-version] -\%[\-help] -.in -.5i +.HP 5 +.B rmm +.RI [ +folder ] +.RI [ msgs ] +.RB [ \-link " | " \-nolink ] +.RB [ \-version ] +.RB [ \-help ] .SH DESCRIPTION -By default, \fIrmm\fR will remove the specified messages by renaming +By default, +.B rmm +will remove the specified messages by renaming the message files with preceding commas. Such files will then need to be removed in some manner after a certain amount of time. Many sites -arrange for \fIcron\fR\0(8) to remove these files once a day, so check +arrange for +.B cron +to remove these files once a day, so check with your system administrator. - -Alternately, if you wish for \fIrmm\fR to really remove the files -representing these messages, you can use the `-unlink' switch. But +.PP +Alternately, if you wish for +.B rmm +to really remove the files +representing these messages, you can use the +.B \-unlink +switch. But messages removed by this method cannot be later recovered. - +.PP If you prefer a more sophisticated method of `removing' messages, you -can define the \fIrmmproc\fR profile component. For example, you can +can define the +.I rmmproc +profile component. For example, you can add a profile component such as - - rmmproc: /home/coleman/bin/rmm_msgs - -then instead of simply renaming the message file, \fIrmm\fR will call +.PP +.RS 5 +rmmproc: /home/foouser/bin/rmm_msgs +.RE +.PP +then instead of simply renaming the message file, +.B rmm +will call the named program or script to handle the files that represent the messages to be deleted. - -Some users of csh prefer the following: - - alias rmm 'refile +d' - -where folder +d is a folder for deleted messages, and - - alias mexp 'rm `mhpath +d all`' - +.PP +Some users of +.B csh +prefer the following: +.PP +.RS 5 +alias rmm 'refile +d' +.RE +.PP +where folder `+d' is a folder for deleted messages, and +.PP +.RS 5 +alias mexp 'rm `mhpath +d all`' +.RE +.PP is used to \*(lqexpunge\*(rq deleted messages. - -The current message is not changed by \fIrmm\fR, so a \fInext\fR will +.PP +The current message is not changed by +.BR rmm , +so a +.B next + will advance to the next message in the folder as expected. -.Fi + +.SH FILES +.fc ^ ~ +.nf +.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile -.Pr +.fi + +.SH "PROFILE COMPONENTS" +.fc ^ ~ +.nf +.ta 2.4i +.ta \w'ExtraBigProfileName 'u ^Path:~^To determine the user's nmh directory -.Ps ^Current\-Folder:~^To find the default current folder -.Ps ^rmmproc:~^Program to delete the message -.Sa +.fi + +.SH "SEE ALSO" refile(1), rmf(1) -.De -`+folder' defaults to the current folder -.Ds -`msgs' defaults to cur -.Ds -`-nounlink' -.Co + +.SH DEFAULTS +.nf +.RB ` +folder "' defaults to the current folder" +.RB ` msgs "' defaults to cur" +.RB ` -nounlink ' +.fi + +.SH CONTEXT If a folder is given, it will become the current folder. -.Bu -Since \fIrefile\fR uses your \fIrmmproc\fP to delete the message, -the \fIrmmproc\fP must \fBNOT\fP call \fIrefile\fP without specifying -`\-normmproc', or you will create an infinte loop. -.En + +.SH BUGS +Since +.B refile +uses your +.I rmmproc +to delete the message, +the +.I rmmproc +must +.B NOT +call +.B refile +without specifying +.BR \-normmproc , +or you will create an infinte loop. diff --git a/man/scan.man b/man/scan.man index 1df9882..de0a280 100644 --- a/man/scan.man +++ b/man/scan.man @@ -2,161 +2,257 @@ .\" %nmhwarning% .\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" .TH SCAN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME scan \- produce a one line per message scan listing .SH SYNOPSIS -.in +.5i -.ti -.5i -scan -\%[+folder] \%[msgs] -\%[\-clear] \%[\-noclear] -\%[\-form\ formatfile] -\%[\-format\ string] -\%[\-header] \%[\-noheader] -\%[\-width\ columns] -\%[\-reverse] \%[\-noreverse] -\%[\-file filename] -.br -\%[\-version] -\%[\-help] -.in -.5i +.HP 5 +.B scan +.RI [ +folder ] +.RI [ msgs ] +.RB [ \-clear " | " \-noclear ] +.RB [ \-form +.IR formatfile ] +.RB [ \-format +.IR string ] +.RB [ \-header " | " \-noheader ] +.RB [ \-width +.IR columns ] +.RB [ \-reverse " | " \-noreverse ] +.RB [ \-file +.IR filename ] +.RB [ \-version ] +.RB [ \-help ] .SH DESCRIPTION -\fIScan\fR produces a one\-line\-per\-message listing of the specified -folder or messages. Each \fIscan\fR line contains the message number +.B Scan +produces a one\-line\-per\-message listing of the specified +folder or messages. Each +.B scan +line contains the message number (name), the date, the \*(lqFrom:\*(rq field, the \*(lqSubject\*(rq field, and, if room allows, some of the body of the message. For example: - +.PP +.RS 5 .nf -.in +.5i .ta \w'15+- 'u +\w'07/\|05x 'u +\w'Dcrocker 'u 15+ 10/\|05 crocker nned\0\0\*(<> if the body is sufficiently short. \fIScan\fR +\*(lq<<\*(rq, and terminated by \*(lq>>\*(rq if the body is sufficiently short. +.B Scan actually reads each of the specified messages and parses them to extract the desired fields. During parsing, appropriate error messages will be produced if there are format errors in any of the messages. - -By default, \fIscan\fR will decode RFC-2047 (MIME) encoding in -these scan listings. \fIScan\fR will only decode these fields if your +.PP +By default, +.B scan +will decode RFC-2047 (MIME) encoding in +these scan listings. +.B Scan +will only decode these fields if your terminal can natively display the character set used in the encoding. You should set the MM_CHARSET environment variable to your native character set, if it is not US-ASCII. See the mh-profile(5) man page for details about this environment variable. - -The switch `\-reverse', makes \fIscan\fR list the messages in reverse +.PP +The switch +.BR \-reverse , +makes +.B scan +list the messages in reverse order. - -The `\-file filename' switch allows the user to obtain a \fIscan\fP -listing of a maildrop file as produced by \fIpackf\fP. This listing +.PP +The +.B \-file +.I filename +switch allows the user to obtain a +.B scan +listing of a maildrop file as produced by +.BR packf . +This listing includes every message in the file (you can't scan individual messages). -The switch `\-reverse' is ignored with this option. - -The switch `\-width\ columns' may be used to specify the width of +The switch +.B \-reverse +is ignored with this option. +.PP +The switch +.B \-width +.I columns +may be used to specify the width of the scan line. The default is to use the width of the terminal. - -The `\-header' switch produces a header line prior to the \fIscan\fR +.PP +The +.B \-header +switch produces a header line prior to the +.B scan listing. Currently, the name of the folder and the current date and -time are output (see the \fBHISTORY\fR section for more information). - -If the `\-clear' switch is used and \fIscan's\fR output is directed -to a terminal, then \fIscan\fR will consult the environment variables -\fB$TERM\fR and \fB$TERMCAP\fR to determine your terminal type in order -to find out how to clear the screen prior to exiting. If the `\-clear' -switch is used and \fIscan's\fR output is not directed to a terminal -(e.g., a pipe or a file), then \fIscan\fR will send a formfeed prior +time are output (see the +.B HISTORY +section for more information). +.PP +If the +.B \-clear +switch is used and +.BR scan 's +output is directed +to a terminal, then +.B scan +will consult the environment variables +.B $TERM +and +.B $TERMCAP +to determine your terminal type in order +to find out how to clear the screen prior to exiting. If the +.B \-clear +switch is used and +.BR scan 's +output is not directed to a terminal +(e.g., a pipe or a file), then +.B scan +will send a formfeed prior to exiting. - +.PP For example, the command: - -.ti +.5i +.PP +.RS 5 (scan \-clear \-header; show all \-show pr \-f) | lpr - +.RE +.PP produces a scan listing of the current folder, followed by a formfeed, followed by a formatted listing of all messages in the folder, one -per page. Omitting `\-show\ pr\ \-f' will cause the messages to be +per page. Omitting +.RB \*(lq "\-show\ pr\ \-f" \*(rq +will cause the messages to be concatenated, separated by a one\-line header and two blank lines. - -To override the output format used by \fIscan\fR, the `\-format\ string' -or `\-form\ file' switches are used. This permits individual fields of +.PP +To override the output format used by +.BR scan , +the +.B \-format +.I string +or +.B \-form +.I file +switches are used. This permits individual fields of the scan listing to be extracted with ease. The string is simply a format -string and the file is simply a format file. See \fImh\-format\fR(5) +string and the file is simply a format file. See +.BR mh\-format (5) for the details. - -In addition to the standard \fImh\-format\fR(5) escapes, \fIscan\fR -also recognizes the following additional \fIcomponent\fR escapes: -.sp 1 +.PP +In addition to the standard +.BR mh\-format (5) +escapes, +.B scan +also recognizes the following additional +.I component +escapes: +.PP +.RS 5 .nf .ta \w'Dtimenow 'u +\w'Returns 'u -\fIEscape\fR \fIReturns\fR \fIDescription\fR +.I Escape Returns Description body string the (compressed) first part of the body dtimenow date the current date folder string the name of the current folder -.re .fi - -If no date header is present in the message, the \fIfunction\fR escapes -which operate on {\fIdate\fP\|} will return values for the date of last +.RE +.PP +If no date header is present in the message, the +.I function +escapes +which operate on +.RB { date } +will return values for the date of last modification of the message file itself. This feature is handy for -scanning a \fIdraft folder\fR, as message drafts usually aren't allowed +scanning a draft folder, as message drafts usually aren't allowed to have dates in them. +.PP +.B scan +will update the +.B nmh +context prior to starting the listing, +so interrupting a long +.B scan +listing preserves the new context. +.B nmh +purists hate this idea. -\fIscan\fR will update the \fInmh\fR context prior to starting the listing, -so interrupting a long \fIscan\fR listing preserves the new context. -\fInmh\fR purists hate this idea. -.Fi +.SH FILES +.fc ^ ~ +.nf +.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile -.Pr +.fi + +.SH "PROFILE COMPONENTS" +.fc ^ ~ +.nf +.ta 2.4i +.ta \w'ExtraBigProfileName 'u ^Path:~^To determine the user's nmh directory -.Ps ^Alternate\-Mailboxes:~^To determine the user's mailboxes -.Ps ^Current\-Folder:~^To find the default current folder -.Sa +.fi + +.SH "SEE ALSO" inc(1), pick(1), show(1), mh\-format(5) -.De -`+folder' defaults to the current folder -.Ds -`msgs' defaults to all -.Ds -`\-format' defaulted as described above -.Ds -`\-noheader' -.Ds -`\-width' defaulted to the width of the terminal -.Co + +.SH DEFAULTS +.nf +.RB ` +folder "' defaults to the current folder" +.RB ` msgs "' defaults to all" +.RB ` \-format "' defaulted as described above" +.RB ` \-noheader ' +.RB ` \-width "' defaulted to the width of the terminal" +.fi + +.SH CONTEXT If a folder is given, it will become the current folder. -.Hi -Prior to using the format string mechanism, `\-header' used to generate + +.SH HISTORY +Prior to using the format string mechanism, +.B \-header +used to generate a heading saying what each column in the listing was. Format strings prevent this from happening. -.Bu -The argument to the `\-format' switch must be interpreted as a single -token by the shell that invokes \fIscan\fR. Therefore, one must usually -place the argument to this switch inside double\-quotes. -The value of each \fIcomponent\fR escape is set by \fIscan\fR to the -contents of the first message header \fIscan\fR encounters with the +.SH BUGS +The argument to the +.B \-format +switch must be interpreted as a single +token by the shell that invokes +.BR scan . +Therefore, one must usually +place the argument to this switch inside double\-quotes. +.PP +The value of each +.I component +escape is set by +.B scan +to the +contents of the first message header +.B scan +encounters with the corresponding component name; any following headers with the same component name are ignored. -.En diff --git a/man/send.man b/man/send.man index 33f5b3d..917e271 100644 --- a/man/send.man +++ b/man/send.man @@ -2,200 +2,311 @@ .\" %nmhwarning% .\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" .TH SEND %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME send \- send a message .SH SYNOPSIS -.in +.5i -.ti -.5i -send -\%[\-alias\ aliasfile] -\%[\-draft] -\%[\-draftfolder\ +folder] -.br -\%[\-draftmessage\ msg] \%[\-nodraftfolder] -.br -\%[\-filter\ filterfile] \%[\-nofilter] -\%[\-format] \%[\-noformat] -.br -\%[\-forward] \%[\-noforward] -\%[\-mime] \%[\-nomime] -\%[\-msgid] -.br -\%[\-nomsgid] -\%[\-push] \%[\-nopush] -\%[\-split\ seconds] -.br -\%[\-verbose] \%[\-noverbose] -\%[\-watch] \%[\-nowatch] -\%[\-sasl] \%[\-saslmech\ mechanism] \%[\-user\ username] -.br -\%[\-width\ columns] -\%[file\ ...] -\%[\-version] -\%[\-help] -.in -.5i +.HP 5 +.B send +.RB [ \-alias +.IR aliasfile ] +.RB [ \-draft ] +.RB [ \-draftfolder +.IR +folder ] +.RB [ \-draftmessage +.IR msg ] +.RB [ \-nodraftfolder ] +.RB [ \-filter +.IR filterfile ] +.RB [ \-nofilter ] +.RB [ \-format " | " \-noformat ] +.RB [ \-forward " | " \-noforward ] +.RB [ \-mime " | " \-nomime ] +.RB [ \-msgid " | " \-nomsgid ] +.RB [ \-push " | " \-nopush ] +.RB [ \-split +.IR seconds ] +.RB [ \-verbose " | " \-noverbose ] +.RB [ \-watch " | " \-nowatch ] +.RB [ \-sasl ] +.RB [ \-saslmech +.IR mechanism ] +.RB [ \-user +.IR username ] +.RB [ \-width +.IR columns ] +.RB [ file +\&...] +.RB [ \-version ] +.RB [ \-help ] .SH DESCRIPTION -\fISend\fR will cause each of the specified files to be delivered +.B Send +will cause each of the specified files to be delivered to each of the destinations in the \*(lqTo:\*(rq, \*(lqcc:\*(rq, -\*(lqBcc:\*(rq, and \*(lqFcc:\*(rq fields of the message. If \fIsend\fR -is re\-distributing a message, as invoked from \fIdist\fR, then the +\*(lqBcc:\*(rq, and \*(lqFcc:\*(rq fields of the message. If +.B send +is re\-distributing a message, as invoked from +.BR dist , +then the corresponding \*(lqResent\-xxx\*(rq fields are examined instead. - -By default, \fIsend\fR uses the program \fIpost\fR(8) to do the actual +.PP +By default, +.B send +uses the program +.B post +to do the actual delivery of the messages, although this can be changed by defining the -\fIpostproc\fR profile component. Most of the features attributed to -\fIsend\fR are actually performed by \fIpost\fR. - -If `\-push' is specified, \fIsend\fR will detach itself from the user's -terminal and perform its actions in the background. If \fIpush\fR\0'd +.I postproc +profile component. Most of the features attributed to +.B send +are actually performed by +.BR post . +.PP +If +.B \-push +is specified, +.B send +will detach itself from the user's +terminal and perform its actions in the background. If +.BR push 'd and the draft can't be sent, then an error message will be sent (using -the mailproc) back to the user. If `\-forward' is given, then a copy -of the draft will be attached to this failure notice. Using `\-push' -differs from putting \fIsend\fR in the background because the output is -trapped and analyzed by \fInmh\fR. - -If `\-verbose' is specified, \fIsend\fR will indicate the interactions +the mailproc) back to the user. If +.B \-forward +is given, then a copy +of the draft will be attached to this failure notice. Using +.B \-push +differs from putting +.B send +in the background because the output is +trapped and analyzed by +.BR nmh . +.PP +If +.B \-verbose +is specified, +.B send +will indicate the interactions occurring with the transport system, prior to actual delivery. -If `\-watch' is specified \fIsend\fR will monitor the delivery of local +If +.B \-watch +is specified +.B send +will monitor the delivery of local and network mail. Hence, by specifying both switches, a large detail of information can be gathered about each step of the message's entry into the transport system. - -The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke -the \fInmh\fR draft folder facility. This is an advanced (and highly -useful) feature. Consult the \fImh-draft\fR(5) man page for more +.PP +The +.B \-draftfolder +.I +folder +and +.B \-draftmessage +.I msg +switches invoke +the +.B nmh +draft folder facility. This is an advanced (and highly +useful) feature. Consult the +.BR mh-draft (5) +man page for more information. - -If `\-split' is specified, \fIsend\fR will split the draft into one +.PP +If +.B \-split +is specified, +.B send +will split the draft into one or more partial messages prior to sending. This makes use of the -MIME features in nmh. Note however that if \fIsend\fR is -invoked under \fIdist\fR\0(1), then this switch is ignored\0--\0it makes +MIME features in +.BR nmh . +Note however that if +.B send +is +invoked under +.BR dist , +then this switch is ignored\0--\0it makes no sense to redistribute a message in this fashion. Sometimes you want -\fIsend\fR to pause after posting a partial message. This is usually -the case when you are running \fIsendmail\fR and expect to generate a -lot of partial messages. The argument to `\-split' tells it how long +.B send +to pause after posting a partial message. This is usually +the case when you are running +.B sendmail +and expect to generate a +lot of partial messages. The argument to +.B \-split +tells it how long to pause between postings. - -\fISend\fR with no \fIfile\fR argument will query whether the draft -is the intended file, whereas `\-draft' will suppress this question. +.PP +.B Send +with no +.I file +argument will query whether the draft +is the intended file, whereas +.B \-draft +will suppress this question. Once the transport system has successfully accepted custody of the message, the file will be renamed with a leading comma, which allows it to be retrieved until the next draft message is sent. If there are -errors in the formatting of the message, \fIsend\fR will abort with a +errors in the formatting of the message, +.B send +will abort with a (hopefully) helpful error message. - +.PP If a \*(lqBcc:\*(rq field is encountered, its addresses will be used for delivery, and the \*(lqBcc:\*(rq field will be removed from the message sent to sighted recipients. The blind recipients will receive an entirely new message with a minimal set of headers. Included in the body of the message will be a copy of the message sent to the sighted recipients. -If `\-filter\ filterfile' is specified, then this copy is filtered -(re\-formatted) by \fImhl\fR prior to being sent to the blind recipients. -Alternately, if you specify the `-mime' switch, then \fIsend\fR will +If +.B \-filter +.I filterfile +is specified, then this copy is filtered +(re\-formatted) by +.B mhl +prior to being sent to the blind recipients. +Alternately, if you specify the +.B -mime +switch, then +.B send +will use the MIME rules for encapsulation. - +.PP Prior to sending the message, the fields \*(lqFrom:\ user@local\*(rq, and \*(lqDate:\ now\*(rq will be appended to the headers in the message. -If the environment variable \fB$SIGNATURE\fR is set, then its value +If the environment variable +.B $SIGNATURE +is set, then its value is used as your personal name when constructing the \*(lqFrom:\*(rq line of the message. If this environment variable is not set, then -\fIsend\fR will consult the profile entry \*(lqSignature\*(rq for -this information. On hosts where \fInmh\fR was configured with the UCI -option, if \fB$SIGNATURE\fR is not set and the \*(lqSignature\*(rq profile -entry is not present, then the file \fB$HOME\fR/.signature is consulted. -If `\-msgid' is specified, then a \*(lqMessage\-ID:\*(rq field will also +.B send +will consult the profile entry \*(lqSignature\*(rq for +this information. +If +.B \-msgid +is specified, then a \*(lqMessage\-ID:\*(rq field will also be added to the message. - -If \fIsend\fR is re\-distributing a message (when invoked by -\fIdist\fR\0), then \*(lqResent\-\*(rq will be prepended to each of these +.PP +If +.B send +is re\-distributing a message (when invoked by +.BR dist ), +then \*(lqResent\-\*(rq will be prepended to each of these fields: \*(lqFrom:\*(rq, \*(lqDate:\*(rq, and \*(lqMessage\-ID:\*(rq. If the message already contains a \*(lqFrom:\*(rq field, then a \*(lqSender: user@local\*(rq field will be added as well. (An already existing \*(lqSender:\*(rq field is an error!) - -By using the `\-format' switch, each of the entries in the \*(lqTo:\*(rq +.PP +By using the +.B \-format +switch, each of the entries in the \*(lqTo:\*(rq and \*(lqcc:\*(rq fields will be replaced with \*(lqstandard\*(rq format entries. This standard format is designed to be usable by all of the message handlers on the various systems around the Internet. -If `\-noformat' is given, then headers are output exactly as they appear +If +.B \-noformat +is given, then headers are output exactly as they appear in the message draft. - +.PP If an \*(lqFcc:\ folder\*(rq is encountered, the message will be copied to the specified folder for the sender in the format in which it will appear to any non\-Bcc receivers of the message. That is, it will have the appended fields and field reformatting. The \*(lqFcc:\*(rq fields will be removed from all outgoing copies of the message. - -By using the `\-width\ columns' switch, the user can direct \fIsend\fR +.PP +By using the +.B \-width +.I columns +switch, the user can direct +.B send as to how long it should make header lines containing addresses. - -If nmh has been compiled with SASL support, the `\-sasl' switch will enable +.PP +If +.B nmh +has been compiled with SASL support, the +.B \-sasl +switch will enable the use of SASL authentication with the SMTP MTA. Depending on the SASL mechanism used, this may require an additional password prompt from the -user (but the \*(lq.netrc\*(rq file can be used to store this password). -`\-saslmech' switch can be used to select a particular SASL mechanism, -and the the `\-user' switch can be used to select a authorization userid +user (but the +.RI \*(lq \&.netrc \*(rq +file can be used to store this password). +.B \-saslmech +switch can be used to select a particular SASL mechanism, +and the the +.B \-user +switch can be used to select a authorization userid to provide to SASL other than the default. - -Currently SASL security layers are not supported for SMTP. nmh's SMTP SASL code +.PP +Currently SASL security layers are not supported for SMTP. +.BR nmh 's +SMTP SASL code will always negotiate an unencrypted connection. This means that while the SMTP authentication can be encrypted, the subsequent data stream can not. This is in -contrast to nmh's POP3 SASL support, where encryption is supported for both the +contrast to +.BR nmh 's +POP3 SASL support, where encryption is supported for both the authentication and the data stream. - +.PP The files specified by the profile entry \*(lqAliasfile:\*(rq and any -additional alias files given by the `\-alias aliasfile' switch will be -read (more than one file, each preceded by `\-alias', can be named). -See \fImh\-alias\fR\0(5) for more information. -.Fi +additional alias files given by the +.B \-alias +.I aliasfile +switch will be +read (more than one file, each preceded by +.BR \-alias , +can be named). +See +.BR mh\-alias (5) +for more information. + +.SH FILES +.fc ^ ~ +.nf +.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile -.Pr +.fi + +.SH "PROFILE COMPONENTS" +.fc ^ ~ +.nf +.ta 2.4i +.ta \w'ExtraBigProfileName 'u ^Path:~^To determine the user's nmh directory -.Ps ^Draft\-Folder:~^To find the default draft\-folder -.Ps ^Aliasfile:~^For a default alias file -.Ps ^Signature:~^To determine the user's mail signature -.Ps ^mailproc:~^Program to post failure notices -.Ps ^postproc:~^Program to post the message -.Sa +.fi + +.SH "SEE ALSO" comp(1), dist(1), forw(1), repl(1), mh\-alias(5), post(8) -.De -`file' defaults to /draft -.Ds -`\-alias %etcdir%/MailAliases' -.Ds -`\-nodraftfolder' -.Ds -`\-nofilter' -.Ds -`\-format' -.Ds -`\-forward' -.Ds -`\-nomime' -.Ds -`\-nomsgid' -.Ds -`\-nopush' -.Ds -`\-noverbose' -.Ds -`\-nowatch' -.Ds -`\-width\ 72' -.Co + +.SH DEFAULTS +.nf +.RB ` file "' defaults to /draft" +.RB ` \-alias "' defaults to %etcdir%/MailAliases" +.RB ` \-nodraftfolder ' +.RB ` \-nofilter ' +.RB ` \-format ' +.RB ` \-forward ' +.RB ` \-nomime ' +.RB ` \-nomsgid ' +.RB ` \-nopush ' +.RB ` \-noverbose ' +.RB ` \-nowatch ' +.RB ` "\-width\ 72" ' +.fi + +.SH CONTEXT None -.Bu + +.SH BUGS Under some configurations, it is not possible to monitor the mail delivery -transaction; `\-watch' is a no-op on those systems. -.sp -Using `\-split\00' doesn't work correctly. -.En +transaction; +.B \-watch +is a no-op on those systems. +.PP +Using +.B \-split +.I 0 +doesn't work correctly. diff --git a/man/sendfiles.man b/man/sendfiles.man index 0837d2b..9b642e0 100644 --- a/man/sendfiles.man +++ b/man/sendfiles.man @@ -2,57 +2,74 @@ .\" %nmhwarning% .\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" .TH SENDFILES %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME sendfiles \- send multiple files via a MIME message .SH SYNOPSIS -.in +.5i -.ti -.5i -sendfiles \%[delay] mailpath subject file1 \%[file2]... -.in -.5i - +.HP +.B sendfiles +.RB [ delay ] +.I mailpath +.I subject +.I file1 +.RI [ file2 +\&...] .SH DESCRIPTION -The shell script \fIsendfiles\fR, is used to send a collection +The shell script +.BR sendfiles , +is used to send a collection of files and directories via electronic mail. -.sp -.in +.5i +.PP +.RS 5 sendfiles mailpath \*(lqsubject\*(rq files\0... -.in -.5i -.sp -\fIsendfiles\fR will archive the files and directories you name -with the \fItar\fR\0(1) command, and then mail the compressed -archive to the `mailpath' with the given `subject'. The archive +.RE +.PP +.B Isendfiles +will archive the files and directories you name +with the +.B tar +command, and then mail the compressed +archive to the \*(lqmailpath\*(rq with the given \*(lqsubject\*(rq. +The archive will be automatically split up into as many messages as necessary in order to get past most mailers. - -Sometimes you want \fIsendfiles\fR to pause after posting a partial -message. This is usually the case when you are running \fIsendmail\fR +.PP +Sometimes you want +.B sendfiles +to pause after posting a partial +message. This is usually the case when you are running +.B sendmail and expect to generate a lot of partial messages. If the first -argument given to \fIsendfiles\fR starts with a dash, then it is +argument given to +.B sendfiles +starts with a dash, then it is interpreted as the number of seconds to pause in between postings, -.ne 6 e.g., -.sp -.in +.5i +.PP +.RS 5 sendfiles -30 mailpath \*(lqsubject\*(rq files\0... -.in -.5i -.sp +.RE +.PP will pause 30 seconds in between each posting. - -.Uh "Extracting the Received Files" -When these messages are received, invoke \fImhstore\fR once for -the list of messages. The default is for \fImhstore\fR to store +.PP +.SS "Extracting the Received Files" +When these messages are received, invoke +.B mhstore +once for +the list of messages. The default is for +.B mhstore +to store the combined parts as a new message in the current folder, although this can be changed using storage formatting strings. You can then -use \fImhlist\fR to find out what's inside; possibly followed by -\fImhstore\fR again to write the archive to a file where you can +use +.B mhlist +to find out what's inside; possibly followed by +.B mhstore +again to write the archive to a file where you can subsequently uncompress and untar it. For instance: -.sp +.PP +.RS 5 .nf -.in +.5i % mhlist 5-8 msg part type/subtype size description 5 message/partial 47K part 1 of 4 @@ -69,14 +86,17 @@ reassembling partials 5,6,7,8 to folder inbox as message 9 conversions=compress % mhstore 9 % uncompress < 9.tar.Z | tar xvpf - -.in -.5i .fi -.sp -Alternately, by using the `\-auto' switch, \fImhstore\fR will -automatically do the extraction for you: -.sp +.RE +.PP +Alternately, by using the +.B \-auto +switch, +.B mhstore +will automatically do the extraction for you: +.PP +.RS 5 .nf -.in +.5i % mhlist 5-8 msg part type/subtype size description 5 message/partial 47K part 1 of 4 @@ -92,59 +112,50 @@ reassembling partials 5,6,7,8 to folder inbox as message 9 type=tar conversions=compress % mhstore -auto 9 --- \fItar\fR listing appears here as files are extracted -.in -.5i +-- tar listing appears here as files are extracted .fi -.sp -As the second \fItar\fR listing is generated, the files are extracted. -A prudent user will never put `\-auto' in the \&.mh\(ruprofile -file. The correct procedure is to first use \fImhlist\fR to find -out what will be extracted. Then \fImhstore\fR can be invoked with -`\-auto' to perform the extraction. -.Fi +.RE +.PP +As the second +.B tar +listing is generated, the files are extracted. +A prudent user will never put +.B \-auto +in the +.I \&.mh\(ruprofile +file. The correct procedure is to first use +.B mhlist +to find out what will be extracted. Then +.B mhstore +can be invoked with +.B \-auto +to perform the extraction. + +.SH FILES +.fc ^ ~ +.nf +.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile -.Pr +.fi + +.SH "PROFILE COMPONENTS" +.fc ^ ~ +.nf +.ta 2.4i +.ta \w'ExtraBigProfileName 'u ^Path:~^To determine the user's nmh directory -.Ps ^Current\-Folder:~^To find the default current folder -.Sa -mhbuild(1), mhlist(1), mhshow(1), mhstore(1) -.br -RFC\-934: -.br - \fIProposed Standard for Message Encapsulation\fR, -.br -RFC\-2045: -.br - \fIMultipurpose Internet Mail Extensions (MIME) Part One: -.br - Format of Internet Message Bodies\fR, -.br -RFC\-2046: -.br - \fIMultipurpose Internet Mail Extensions (MIME) Part Two: -.br - Media Types\fR, -.br -RFC\-2047: -.br - \fIMultipurpose Internet Mail Extensions (MIME) Part Three: -.br - Message Header Extensions for Non-ASCII Text\fR, -.br -RFC\-2048: -.br - \fIMultipurpose Internet Mail Extensions (MIME) Part Four: -.br - Registration Procedures\fR, -.br -RFC\-2049: -.br - \fIMultipurpose Internet Mail Extensions (MIME) Part Five: -.br - Conformance Criteria and Examples\fR. -.De -`\-noverbose' -.Co -None. -.En +.fi + +.SH "SEE ALSO" +mhbuild(1), mhlist(1), mhshow(1), mhstore(1). +.I "Proposed Standard for Message Encapsulation" +(RFC\-934) + +.SH DEFAULTS +.nf +.RB ` \-noverbose ' +.fi + +.SH CONTEXT +None