]> diplodocus.org Git - nmh/blobdiff - man/sendfiles.man
projects / nmh / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Handle teen ordinal suffixes correctly.
[nmh] / man / sendfiles.man
diff --git a/man/sendfiles.man b/man/sendfiles.man
index 94f193e276b774511c402f8cb3a892beb6e454b3..3d2e2724aa0356d507fd7787eaf8683389289832 100644 (file)
--- a/man/sendfiles.man
+++ b/man/sendfiles.man
@@ -1,92 +1,96 @@
-.\"
+.TH SENDFILES %manext1% 2012-11-14 "%nmhversion%"
+.
 .\" %nmhwarning%
 .\" %nmhwarning%
-.\"
-.TH SENDFILES %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.
 .SH NAME
 .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
 .SH SYNOPSIS
 .HP 5
 .na
 .B sendfiles
-.RB [ delay ]
-.I mailpath
+.RB [ \-help ]
+.RB [ \-version ]
+.RB [ -compress
+.IR bzip2 " | " compress " | " gzip " | " lzma " | " none ]
+.br
+.RB [ \-from
+.IR sender ]
+.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
 \&...]
 .ad
 .SH DESCRIPTION
 The shell script
-.BR sendfiles ,
+.B sendfiles
 is used to send a collection
 of files and directories via electronic mail.
 .PP
 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
 .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.
-The archive
-will be automatically split up into as many messages as necessary
-in order to get past most mailers.
+archive to the \*(lqrecipient\*(rq with the given \*(lqsubject\*(rq.
 .PP
 .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.,
+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
 .PP
-.RS 5
-sendfiles -30 mailpath \*(lqsubject\*(rq files\0...
-.RE
+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
 .PP
-will pause 30 seconds in between each posting.
+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
 .SS "Extracting the Received Files"
 .PP
 .SS "Extracting the Received Files"
-When these messages are received, invoke
+When the message is received, invoke
 .B mhstore
 once for
 .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
+the received message.  The default is for
 .B mhstore
 .B mhstore
-again to write the archive to a file where you can
+to write the archive to a file where you can
 subsequently uncompress and untar it.  For instance:
 .PP
 .RS 5
 .nf
 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
+$ mhlist -verbose 9
  msg part  type/subtype             size description
    9       application/octet-stream 118K
              (extract with uncompress | tar xvpf -)
              type=tar
              conversions=compress
  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
 .fi
 .RE
 .PP
@@ -98,21 +102,13 @@ will automatically do the extraction for you:
 .PP
 .RS 5
 .nf
 .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
+$ mhlist -verbose 9
  msg part  type/subtype             size description
    9       application/octet-stream 118K
              (extract with uncompress | tar xvpf -)
              type=tar
              conversions=compress
  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
 -- tar listing appears here as files are extracted
 .fi
 .RE
@@ -123,7 +119,7 @@ listing is generated, the files are extracted.
 A prudent user will never put
 .B \-auto
 in the
 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
 file.  The correct procedure is to first use
 .B mhlist
 to find out what will be extracted.  Then
@@ -131,14 +127,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'%etcdir%/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
+^$HOME/.mh_profile~^The user profile
 .fi
 .fi
-
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
@@ -147,16 +141,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"
 .I "Proposed Standard for Message Encapsulation"
-(RFC\-934)
-
+(RFC 934)
 .SH DEFAULTS
 .nf
 .SH DEFAULTS
 .nf
-.RB ` \-noverbose '
+.RB ` "\-delay\ 0" '
+.RB ` "\-from localmbox" '
 .fi
 .fi
-
 .SH CONTEXT
 None
 .SH CONTEXT
 None
Fork of https://git.savannah.nongnu.org/cgit/nmh.git