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