7d00a718ebb0e1465d38fd3d31e0168e056a8cde
[mmh] / man / sendfiles.man
1 .\"
2 .\" %nmhwarning%
3 .\" $Id$
4 .\"
5 .\" include the -mh macro file
6 .so %etcdir%/tmac.h
7 .\"
8 .TH SENDFILES %manext1% MH.6.8 [%nmhversion%]
9 .SH NAME
10 sendfiles \- send multiple files via a MIME message
11 .SH SYNOPSIS
12 .in +.5i
13 .ti -.5i
14 sendfiles \%[delay] mailpath subject file1 \%[file2]...
15 .in -.5i
16
17 .SH DESCRIPTION
18 The shell script \fIsendfiles\fR, is used to send a collection
19 of files and directories via electronic mail.
20 .sp
21 .in +.5i
22 sendfiles mailpath \*(lqsubject\*(rq files\0...
23 .in -.5i
24 .sp
25 \fIsendfiles\fR will archive the files and directories you name
26 with the \fItar\fR\0(1) command, and then mail the compressed
27 archive to the `mailpath' with the given `subject'.  The archive
28 will be automatically split up into as many messages as necessary
29 in order to get past most mailers.
30
31 Sometimes you want \fIsendfiles\fR to pause after posting a partial
32 message.  This is usually the case when you are running \fIsendmail\fR
33 and expect to generate a lot of partial messages.  If the first
34 argument given to \fIsendfiles\fR starts with a dash, then it is
35 interpreted as the number of seconds to pause in between postings,
36 .ne 6
37 e.g.,
38 .sp
39 .in +.5i
40 sendfiles -30 mailpath \*(lqsubject\*(rq files\0...
41 .in -.5i
42 .sp
43 will pause 30 seconds in between each posting.
44
45 .Uh "Extracting the Received Files"
46 When these messages are received, invoke \fImhstore\fR once for
47 the list of messages.  The default is for \fImhstore\fR to store
48 the combined parts as a new message in the current folder, although
49 this can be changed using storage formatting strings.  You can then
50 use \fImhlist\fR to find out what's inside; possibly followed by
51 \fImhstore\fR again to write the archive to a file where you can
52 subsequently uncompress and untar it.  For instance:
53 .sp
54 .nf
55 .in +.5i
56 % mhlist 5-8
57  msg part  type/subtype             size description
58    5       message/partial           47K part 1 of 4
59    6       message/partial           47K part 2 of 4
60    7       message/partial           47K part 3 of 4
61    8       message/partial           18K part 4 of 4
62 % mhstore 5-8
63 reassembling partials 5,6,7,8 to folder inbox as message 9
64 % mhlist -verbose 9
65  msg part  type/subtype             size description
66    9       application/octet-stream 118K
67              (extract with uncompress | tar xvpf -)
68              type=tar
69              conversions=compress
70 % mhstore 9
71 % uncompress < 9.tar.Z | tar xvpf -
72 .in -.5i
73 .fi
74 .sp
75 Alternately, by using the `\-auto' switch, \fImhstore\fR will
76 automatically do the extraction for you:
77 .sp
78 .nf
79 .in +.5i
80 % mhlist 5-8
81  msg part  type/subtype             size description
82    5       message/partial           47K part 1 of 4
83    6       message/partial           47K part 2 of 4
84    7       message/partial           47K part 3 of 4
85    8       message/partial           18K part 4 of 4
86 % mhstore 5-8
87 reassembling partials 5,6,7,8 to folder inbox as message 9
88 % mhlist -verbose 9
89  msg part  type/subtype             size description
90    9       application/octet-stream 118K
91              (extract with uncompress | tar xvpf -)
92              type=tar
93              conversions=compress
94 % mhstore -auto 9
95 -- \fItar\fR listing appears here as files are extracted
96 .in -.5i
97 .fi
98 .sp
99 As the second \fItar\fR listing is generated, the files are extracted.
100 A prudent user will never put `\-auto' in the \&.mh\(ruprofile
101 file.  The correct procedure is to first use \fImhlist\fR to find
102 out what will be extracted.  Then \fImhstore\fR can be invoked with
103 `\-auto' to perform the extraction.
104 .Fi
105 ^$HOME/\&.mh\(ruprofile~^The user profile
106 .Pr
107 ^Path:~^To determine the user's nmh directory
108 .Ps
109 ^Current\-Folder:~^To find the default current folder
110 .Sa
111 mhbuild(1), mhlist(1), mhshow(1), mhstore(1)
112 .br
113 RFC\-934:
114 .br
115    \fIProposed Standard for Message Encapsulation\fR,
116 .br
117 RFC\-2045:
118 .br
119    \fIMultipurpose Internet Mail Extensions (MIME) Part One:
120 .br
121    Format of Internet Message Bodies\fR,
122 .br
123 RFC\-2046:
124 .br
125    \fIMultipurpose Internet Mail Extensions (MIME) Part Two:
126 .br
127    Media Types\fR,
128 .br
129 RFC\-2047:
130 .br
131    \fIMultipurpose Internet Mail Extensions (MIME) Part Three:
132 .br
133    Message Header Extensions for Non-ASCII Text\fR,
134 .br
135 RFC\-2048:
136 .br
137    \fIMultipurpose Internet Mail Extensions (MIME) Part Four:
138 .br
139    Registration Procedures\fR,
140 .br
141 RFC\-2049:
142 .br
143    \fIMultipurpose Internet Mail Extensions (MIME) Part Five:
144 .br
145    Conformance Criteria and Examples\fR.
146 .De
147 `\-noverbose'
148 .Co
149 None.
150 .En