X-Git-Url: http://git.marmaro.de/?a=blobdiff_plain;f=man%2Fsendfiles.man;h=4b39245845d3da6c19f240f69707f3734f20506a;hb=f8baa5a34335fc0fc8ccabfabc601d0af73ab769;hp=72f843c053a475672a67f67f3284d84152d8ccf2;hpb=1691e80890e5d8ba258c51c214a3e91880e1db2b;p=mmh diff --git a/man/sendfiles.man b/man/sendfiles.man index 72f843c..4b39245 100644 --- a/man/sendfiles.man +++ b/man/sendfiles.man @@ -1,58 +1,122 @@ +.TH SENDFILES %manext1% "October 16, 2012" "%nmhversion%" .\" .\" %nmhwarning% -.\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" -.TH SENDFILES %manext1% 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 5 +.na +.B sendfiles +.RB [ -compress +.IR bzip2 " | " compress " | " gzip " | " lzma " | " none " | " zip ] +.br +.RB [ \-from +.IR sender ] +.RI [ "\-delay n" " | " \-n ] +.RB [ \-version ] +.RB [ \-help ] +.br +.B \-to +.I recipient +.B \-subject +.IR subject " | " +.I recipient +.I subject +.br +.I file/directory1 +.RI [ file/directory2 +\&...] +.ad .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 -%libdir%/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 +.PP +.RS 5 +sendfiles -to recipient -subject \*(lqsubject\*(rq files\0... +.RE +.PP +.B sendfiles +will archive the files and directories you name +with the +.B tar +command, and then mail the compressed +archive to the \*(lqrecipient\*(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 -and expect to generate a lot of partial messages. If the first -argument given to \fIsendfiles\fR starts with a dash, then it is -interpreted as the number of seconds to pause in between postings, -.ne 6 +.PP +The +.B \-to +switch specifies the recipient. The +.B \-subject +switch specifies the subject. Alternatively, these two required values +can be provided without their corresponding switch names. +.PP +The +.B \-from +switch can, and should, be used to specify the sender's mailbox (name +and email address). Alternatively, the +.B PERSON +environment variable can be used for the same purpose. +If neither is used, +.B sendfiles +will supply a \*(lqFrom:\*(rq header field using the sender's local +mailbox, see +.I localmbox +in +.IR mh-format (5). +.PP +The +.B \-compress +command line switch can be used to override the run-time determination +of the compression program by +.BR sendfiles . +.B \-compress +.I none +(alternatively, +.BR \-none ) +disables compression. +.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. The +.B \-delay +switch specifies the number of seconds to pause in between postings, e.g., -.sp -.in +.5i -%libdir%/sendfiles -30 mailpath \*(lqsubject\*(rq files\0... -.in -.5i -.sp -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 +.RS 5 +sendfiles -delay 30 -to recipient -subject \*(lqsubject\*(rq files\0... +.RE +.PP +will pause 30 seconds in between each posting. An alternate form of +the switch with just the delay time, +.BR \-30 , +for example, is also supported. +.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 +133,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 +159,51 @@ 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'%etcdir%/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" +.IR mhbuild (1), +.IR mhlist (1), +.IR mhshow (1), +.IR mhstore (1), +.IR mh-format (5) +.PP +.I "Proposed Standard for Message Encapsulation" +(RFC\-934) +.SH DEFAULTS +.nf +.RB ` "\-delay\ 0" ' +.RB ` "\-from localmbox" ' +.fi +.SH CONTEXT +None