]> diplodocus.org Git - nmh/blob - man/sendfiles.man
Reorder configure options to be before variables
[nmh] / man / sendfiles.man
1 .TH SENDFILES %manext1% 2012-11-14 "%nmhversion%"
2 .
3 .\" %nmhwarning%
4 .
5 .SH NAME
6 sendfiles \- send multiple files by MIME message with nmh
7 .SH SYNOPSIS
8 .HP 5
9 .na
10 .B sendfiles
11 .RB [ \-help ]
12 .RB [ \-version ]
13 .RB [ -compress
14 .IR bzip2 " | " compress " | " gzip " | " lzma " | " none ]
15 .br
16 .RB [ \-from
17 .IR sender ]
18 .br
19 .B \-to
20 .I recipient
21 .B \-subject
22 .IR subject " | "
23 .I recipient
24 .I subject
25 .br
26 .I file/directory1
27 .RI [ file/directory2
28 \&...]
29 .ad
30 .SH DESCRIPTION
31 The shell script
32 .B sendfiles
33 is used to send a collection
34 of files and directories via electronic mail.
35 .PP
36 .B sendfiles
37 will archive the files and directories you name
38 with the
39 .B tar
40 command, and then mail the compressed
41 archive to the \*(lqrecipient\*(rq with the given \*(lqsubject\*(rq.
42 .PP
43 The
44 .B \-to
45 switch specifies the recipient. The
46 .B \-subject
47 switch specifies the subject. Alternatively, these two required values
48 can be provided without their corresponding switch names.
49 .PP
50 The
51 .B \-from
52 switch can, and should, be used to specify the sender's mailbox (name
53 and email address). Alternatively, the
54 .B PERSON
55 environment variable can be used for the same purpose.
56 If neither is used,
57 .B sendfiles
58 will supply a \*(lqFrom:\*(rq header field using the sender's local
59 mailbox, see
60 .I localmbox
61 in
62 .IR mh-format (5).
63 .PP
64 The
65 .B \-compress
66 command line switch can be used to override the run-time determination
67 of the compression program by
68 .BR sendfiles .
69 .B \-compress
70 .I none
71 (alternatively,
72 .BR \-none )
73 disables compression.
74 .PP
75 .SS "Extracting the Received Files"
76 When the message is received, invoke
77 .B mhstore
78 once for
79 the received message. The default is for
80 .B mhstore
81 to write the archive to a file where you can
82 subsequently uncompress and untar it. For instance:
83 .PP
84 .RS 5
85 .nf
86 $ mhlist -verbose 9
87 msg part type/subtype size description
88 9 application/octet-stream 118K
89 (extract with uncompress | tar xvpf -)
90 type=tar
91 conversions=compress
92 $ mhstore 9
93 $ uncompress < 9.tar.Z | tar xvpf -
94 .fi
95 .RE
96 .PP
97 Alternately, by using the
98 .B \-auto
99 switch,
100 .B mhstore
101 will automatically do the extraction for you:
102 .PP
103 .RS 5
104 .nf
105 $ mhlist -verbose 9
106 msg part type/subtype size description
107 9 application/octet-stream 118K
108 (extract with uncompress | tar xvpf -)
109 type=tar
110 conversions=compress
111 $ mhstore -auto 9
112 -- tar listing appears here as files are extracted
113 .fi
114 .RE
115 .PP
116 As the second
117 .B tar
118 listing is generated, the files are extracted.
119 A prudent user will never put
120 .B \-auto
121 in the
122 .I \&.mh_profile
123 file. The correct procedure is to first use
124 .B mhlist
125 to find out what will be extracted. Then
126 .B mhstore
127 can be invoked with
128 .B \-auto
129 to perform the extraction.
130 .SH FILES
131 .fc ^ ~
132 .nf
133 .ta \w'%nmhetcdir%/ExtraBigFileName 'u
134 ^$HOME/.mh_profile~^The user profile
135 .fi
136 .SH "PROFILE COMPONENTS"
137 .fc ^ ~
138 .nf
139 .ta 2.4i
140 .ta \w'ExtraBigProfileName 'u
141 ^Path:~^To determine the user's nmh directory
142 ^Current\-Folder:~^To find the default current folder
143 .fi
144 .SH "SEE ALSO"
145 .IR mhbuild (1),
146 .IR mhlist (1),
147 .IR mhshow (1),
148 .IR mhstore (1),
149 .IR mh-format (5)
150 .PP
151 .I "Proposed Standard for Message Encapsulation"
152 (RFC 934)
153 .SH DEFAULTS
154 .nf
155 .RB ` "\-delay\ 0" '
156 .RB ` "\-from localmbox" '
157 .fi
158 .SH CONTEXT
159 None