Reworked the man page system and some man page contents (mmh-intro).
[mmh] / man / sendfiles.man1
diff --git a/man/sendfiles.man1 b/man/sendfiles.man1
new file mode 100644 (file)
index 0000000..a2bf7be
--- /dev/null
@@ -0,0 +1,157 @@
+.\"
+.\" %nmhwarning%
+.\"
+.TH SENDFILES %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.SH NAME
+sendfiles \- send multiple files via a MIME message
+.SH SYNOPSIS
+.HP
+.na
+.B sendfiles
+.I mailpath
+.I subject
+.I file1
+.RI [ file2
+\&...]
+.ad
+.SH DESCRIPTION
+The shell script
+.BR sendfiles ,
+is used to send a collection
+of files and directories via electronic mail.
+.PP
+.RS 5
+sendfiles mailpath \*(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 \*(lqmailpath\*(rq with the given \*(lqsubject\*(rq.
+.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,
+e.g.,
+.PP
+.RS 5
+sendfiles -30 mailpath \*(lqsubject\*(rq files\0...
+.RE
+.PP
+will pause 30 seconds in between each posting.
+.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
+.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:
+.PP
+.RS 5
+.nf
+% 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
+reassembling partials 5,6,7,8 to folder inbox as message 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 -
+.fi
+.RE
+.PP
+Alternately, by using the
+.B \-auto
+switch,
+.B mhstore
+will automatically do the extraction for you:
+.PP
+.RS 5
+.nf
+% 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
+reassembling partials 5,6,7,8 to folder inbox as message 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
+-- tar listing appears here as files are extracted
+.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 profile.
+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/.mmh/profile~^The user profile
+.fi
+
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName  'u
+^Path:~^To determine the user's mail storage
+^Current\-Folder:~^To find the default current folder
+.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