Removed support for zip from sendfiles. I added it as part of the

[mmh] / man / sendfiles.man

diff --git a/man/sendfiles.man b/man/sendfiles.man
index 9b642e0..020fd9d 100644 (file)
--- a/man/sendfiles.man
+++ b/man/sendfiles.man
@@ -1,19 +1,33 @@
+.TH SENDFILES %manext1% "October 21, 2012" "%nmhversion%"

 .\"
 .\" %nmhwarning%
 .\"
 .\" %nmhwarning%

-.\" $Id$

 .\"
 .\"

-.TH SENDFILES %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]

 .SH NAME
 sendfiles \- send multiple files via a MIME message
 .SH SYNOPSIS
 .SH NAME
 sendfiles \- send multiple files via a MIME message
 .SH SYNOPSIS

-.HP
+.HP 5
+.na

 .B sendfiles
 .B sendfiles

-.RB [ delay ]
-.I mailpath
+.RB [ -compress
+.IR bzip2 " | " compress " | " gzip " | " lzma " | " none ]
+.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
 .I subject

-.I file1
-.RI [ file2
+.br
+.I file/directory1
+.RI [ file/directory2

 \&...]
 \&...]

+.ad

 .SH DESCRIPTION
 The shell script
 .BR sendfiles ,
 .SH DESCRIPTION
 The shell script
 .BR sendfiles ,

@@ -21,36 +35,69 @@ is used to send a collection
 of files and directories via electronic mail.
 .PP
 .RS 5
 of files and directories via electronic mail.
 .PP
 .RS 5

-sendfiles mailpath \*(lqsubject\*(rq files\0...
+sendfiles -to recipient -subject \*(lqsubject\*(rq files\0...

 .RE
 .PP
 .RE
 .PP

-.B Isendfiles
+.B sendfiles

 will archive the files and directories you name
 with the
 .B tar
 command, and then mail the compressed
 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.
+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.
 .PP
 The archive
 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
+.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
 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
 e.g.,
 .PP
 .RS 5

-sendfiles -30 mailpath \*(lqsubject\*(rq files\0...
+sendfiles -delay 30 -to recipient -subject \*(lqsubject\*(rq files\0...

 .RE
 .PP
 .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
 .PP
 .SS "Extracting the Received Files"
 When these messages are received, invoke

@@ -130,14 +177,12 @@ to find out what will be extracted.  Then
 can be invoked with
 .B \-auto
 to perform the extraction.
 can be invoked with
 .B \-auto
 to perform the extraction.

-

 .SH FILES
 .fc ^ ~
 .nf
 .SH FILES
 .fc ^ ~
 .nf

-.ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
+.ta \w'%etcdir%/ExtraBigFileName  'u

 ^$HOME/\&.mh\(ruprofile~^The user profile
 .fi
 ^$HOME/\&.mh\(ruprofile~^The user profile
 .fi

-

 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf

@@ -146,16 +191,19 @@ to perform the extraction.
 ^Path:~^To determine the user's nmh directory
 ^Current\-Folder:~^To find the default current folder
 .fi
 ^Path:~^To determine the user's nmh directory
 ^Current\-Folder:~^To find the default current folder
 .fi

-

 .SH "SEE ALSO"
 .SH "SEE ALSO"

-mhbuild(1), mhlist(1), mhshow(1), mhstore(1). 
+.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)
 .I "Proposed Standard for Message Encapsulation"
 (RFC\-934)

-

 .SH DEFAULTS
 .nf
 .SH DEFAULTS
 .nf

-.RB ` \-noverbose '
+.RB ` "\-delay\ 0" '
+.RB ` "\-from localmbox" '

 .fi
 .fi

-

 .SH CONTEXT
 None
 .SH CONTEXT
 None