X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/95e9c4e6befb17ca3e691c26f024fb55eeae5e31..04ee0c3f6ad7e4177cc43a0c57f046013a4fbac9:/man/sendfiles.man diff --git a/man/sendfiles.man b/man/sendfiles.man index d8c7f3d8..e6e84a53 100644 --- a/man/sendfiles.man +++ b/man/sendfiles.man @@ -1,37 +1,39 @@ -.TH SENDFILES %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] -.\" +.TH SENDFILES %manext1% 2012-11-14 "%nmhversion%" +. .\" %nmhwarning% -.\" +. .SH NAME -sendfiles \- send multiple files via a MIME message +sendfiles \- send multiple files by MIME message with nmh .SH SYNOPSIS .HP 5 .na .B sendfiles -.RB [ \-bzip2 " | " \-compress " | " \-gzip " | " \-lzma " | " \-none " | " -zip ] +.RB [ \-help ] +.RB [ \-version ] +.RB [ -compress +.IR bzip2 " | " compress " | " gzip " | " lzma " | " none ] .br .RB [ \-from .IR sender ] -.RI [ \-delay ] -.RB [ \-version ] -.RB [ \-help ] +.RI [ "\-delay n" " | " \-n ] .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 -.BR sendfiles , +.B sendfiles is used to send a collection of files and directories via electronic mail. .PP -.RS 5 -sendfiles recipient \*(lqsubject\*(rq files\0... -.RE -.PP .B sendfiles will archive the files and directories you name with the @@ -43,6 +45,13 @@ will be automatically split up into as many messages as necessary in order to get past most mailers. .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 @@ -56,28 +65,35 @@ mailbox, see in .IR mh-format (5). .PP -The remaining command line switches select the compression program. -One of these can be used to override the run-time determination of -the compression program by +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. If the first -argument given to -.B sendfiles -starts with a dash, then it is -interpreted as the number of seconds to pause in between postings, +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., .PP .RS 5 -sendfiles -30 recipient \*(lqsubject\*(rq files\0... +sendfiles -delay 30 -to recipient -subject \*(lqsubject\*(rq files\0... .RE .PP -will pause 30 seconds in between each posting. +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 @@ -97,22 +113,22 @@ subsequently uncompress and untar it. For instance: .PP .RS 5 .nf -% mhlist 5-8 +$ mhlist 5-8 msg part type/subtype size description 5 message/partial 47K part 1 of 4 6 message/partial 47K part 2 of 4 7 message/partial 47K part 3 of 4 8 message/partial 18K part 4 of 4 -% mhstore 5-8 +$ mhstore 5-8 reassembling partials 5,6,7,8 to folder inbox as message 9 -% mhlist -verbose 9 +$ mhlist -verbose 9 msg part type/subtype size description 9 application/octet-stream 118K (extract with uncompress | tar xvpf -) type=tar conversions=compress -% mhstore 9 -% uncompress < 9.tar.Z | tar xvpf - +$ mhstore 9 +$ uncompress < 9.tar.Z | tar xvpf - .fi .RE .PP @@ -124,21 +140,21 @@ will automatically do the extraction for you: .PP .RS 5 .nf -% mhlist 5-8 +$ mhlist 5-8 msg part type/subtype size description 5 message/partial 47K part 1 of 4 6 message/partial 47K part 2 of 4 7 message/partial 47K part 3 of 4 8 message/partial 18K part 4 of 4 -% mhstore 5-8 +$ mhstore 5-8 reassembling partials 5,6,7,8 to folder inbox as message 9 -% mhlist -verbose 9 +$ mhlist -verbose 9 msg part type/subtype size description 9 application/octet-stream 118K (extract with uncompress | tar xvpf -) type=tar conversions=compress -% mhstore -auto 9 +$ mhstore -auto 9 -- tar listing appears here as files are extracted .fi .RE @@ -149,7 +165,7 @@ listing is generated, the files are extracted. A prudent user will never put .B \-auto in the -.I \&.mh\(ruprofile +.I \&.mh_profile file. The correct procedure is to first use .B mhlist to find out what will be extracted. Then @@ -160,8 +176,8 @@ to perform the extraction. .SH FILES .fc ^ ~ .nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile +.ta \w'%nmhetcdir%/ExtraBigFileName 'u +^$HOME/.mh_profile~^The user profile .fi .SH "PROFILE COMPONENTS" .fc ^ ~ @@ -179,7 +195,7 @@ to perform the extraction. .IR mh-format (5) .PP .I "Proposed Standard for Message Encapsulation" -(RFC\-934) +(RFC 934) .SH DEFAULTS .nf .RB ` "\-delay\ 0" '