use %etcdir% for spacing instead of hardcoding
[mmh] / man / sendfiles.man
1 .\"
2 .\" %nmhwarning%
3 .\" $Id$
4 .\"
5 .TH SENDFILES %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
6 .SH NAME
7 sendfiles \- send multiple files via a MIME message
8 .SH SYNOPSIS
9 .HP
10 .na
11 .B sendfiles
12 .RB [ delay ]
13 .I mailpath
14 .I subject
15 .I file1
16 .RI [ file2
17 \&...]
18 .ad
19 .SH DESCRIPTION
20 The shell script
21 .BR sendfiles ,
22 is used to send a collection
23 of files and directories via electronic mail.
24 .PP
25 .RS 5
26 sendfiles mailpath \*(lqsubject\*(rq files\0...
27 .RE
28 .PP
29 .B Isendfiles
30 will archive the files and directories you name
31 with the
32 .B tar
33 command, and then mail the compressed
34 archive to the \*(lqmailpath\*(rq with the given \*(lqsubject\*(rq.
35 The archive
36 will be automatically split up into as many messages as necessary
37 in order to get past most mailers.
38 .PP
39 Sometimes you want
40 .B sendfiles
41 to pause after posting a partial
42 message.  This is usually the case when you are running
43 .B sendmail
44 and expect to generate a lot of partial messages.  If the first
45 argument given to
46 .B sendfiles
47 starts with a dash, then it is
48 interpreted as the number of seconds to pause in between postings,
49 e.g.,
50 .PP
51 .RS 5
52 sendfiles -30 mailpath \*(lqsubject\*(rq files\0...
53 .RE
54 .PP
55 will pause 30 seconds in between each posting.
56 .PP
57 .SS "Extracting the Received Files"
58 When these messages are received, invoke
59 .B mhstore
60 once for
61 the list of messages.  The default is for
62 .B mhstore
63 to store
64 the combined parts as a new message in the current folder, although
65 this can be changed using storage formatting strings.  You can then
66 use
67 .B mhlist
68 to find out what's inside; possibly followed by
69 .B mhstore
70 again to write the archive to a file where you can
71 subsequently uncompress and untar it.  For instance:
72 .PP
73 .RS 5
74 .nf
75 % mhlist 5-8
76  msg part  type/subtype             size description
77    5       message/partial           47K part 1 of 4
78    6       message/partial           47K part 2 of 4
79    7       message/partial           47K part 3 of 4
80    8       message/partial           18K part 4 of 4
81 % mhstore 5-8
82 reassembling partials 5,6,7,8 to folder inbox as message 9
83 % mhlist -verbose 9
84  msg part  type/subtype             size description
85    9       application/octet-stream 118K
86              (extract with uncompress | tar xvpf -)
87              type=tar
88              conversions=compress
89 % mhstore 9
90 % uncompress < 9.tar.Z | tar xvpf -
91 .fi
92 .RE
93 .PP
94 Alternately, by using the
95 .B \-auto
96 switch,
97 .B mhstore
98 will automatically do the extraction for you:
99 .PP
100 .RS 5
101 .nf
102 % mhlist 5-8
103  msg part  type/subtype             size description
104    5       message/partial           47K part 1 of 4
105    6       message/partial           47K part 2 of 4
106    7       message/partial           47K part 3 of 4
107    8       message/partial           18K part 4 of 4
108 % mhstore 5-8
109 reassembling partials 5,6,7,8 to folder inbox as message 9
110 % mhlist -verbose 9
111  msg part  type/subtype             size description
112    9       application/octet-stream 118K
113              (extract with uncompress | tar xvpf -)
114              type=tar
115              conversions=compress
116 % mhstore -auto 9
117 -- tar listing appears here as files are extracted
118 .fi
119 .RE
120 .PP
121 As the second
122 .B tar
123 listing is generated, the files are extracted.
124 A prudent user will never put
125 .B \-auto
126 in the
127 .I \&.mh\(ruprofile
128 file.  The correct procedure is to first use
129 .B mhlist
130 to find out what will be extracted.  Then
131 .B mhstore
132 can be invoked with
133 .B \-auto
134 to perform the extraction.
135
136 .SH FILES
137 .fc ^ ~
138 .nf
139 .ta \w'%etcdir%/ExtraBigFileName  'u
140 ^$HOME/\&.mh\(ruprofile~^The user profile
141 .fi
142
143 .SH "PROFILE COMPONENTS"
144 .fc ^ ~
145 .nf
146 .ta 2.4i
147 .ta \w'ExtraBigProfileName  'u
148 ^Path:~^To determine the user's nmh directory
149 ^Current\-Folder:~^To find the default current folder
150 .fi
151
152 .SH "SEE ALSO"
153 mhbuild(1), mhlist(1), mhshow(1), mhstore(1). 
154 .I "Proposed Standard for Message Encapsulation"
155 (RFC\-934)
156
157 .SH DEFAULTS
158 .nf
159 .RB ` \-noverbose '
160 .fi
161
162 .SH CONTEXT
163 None