File: sendfiles.man

package info (click to toggle)
nmh 1.8-4
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 7,860 kB
  • sloc: ansic: 50,445; sh: 22,697; makefile: 1,138; lex: 740; perl: 509; yacc: 265
file content (159 lines) | stat: -rw-r--r-- 3,300 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
.TH SENDFILES %manext1% 2012-11-14 "%nmhversion%"
.
.\" %nmhwarning%
.
.SH NAME
sendfiles \- send multiple files by MIME message with nmh
.SH SYNOPSIS
.HP 5
.na
.B sendfiles
.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
.br
.I file/directory1
.RI [ file/directory2
\&...]
.ad
.SH DESCRIPTION
The shell script
.B sendfiles
is used to send a collection
of files and directories via electronic mail.
.PP
.B sendfiles
will archive the files and directories you name
with the
.B tar
command, and then mail the compressed
archive to the \*(lqrecipient\*(rq with the given \*(lqsubject\*(rq.
.PP
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
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
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"
When the message is received, invoke
.B mhstore
once for
the received message.  The default is for
.B mhstore
to write the archive to a file where you can
subsequently uncompress and untar it.  For instance:
.PP
.RS 5
.nf
$ mhlist -verbose 9
 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 -
.fi
.RE
.PP
Alternately, by using the
.B \-auto
switch,
.B mhstore
will automatically do the extraction for you:
.PP
.RS 5
.nf
$ mhlist -verbose 9
 msg part  type/subtype             size description
   9       application/octet-stream 118K
             (extract with uncompress | tar xvpf -)
             type=tar
             conversions=compress
$ mhstore -auto 9
-- tar listing appears here as files are extracted
.fi
.RE
.PP
As the second
.B tar
listing is generated, the files are extracted.
A prudent user will never put
.B \-auto
in the
.I \&.mh_profile
file.  The correct procedure is to first use
.B mhlist
to find out what will be extracted.  Then
.B mhstore
can be invoked with
.B \-auto
to perform the extraction.
.SH FILES
.fc ^ ~
.nf
.ta \w'%nmhetcdir%/ExtraBigFileName  'u
^$HOME/.mh_profile~^The user profile
.fi
.SH "PROFILE COMPONENTS"
.fc ^ ~
.nf
.ta 2.4i
.ta \w'ExtraBigProfileName  'u
^Path:~^To determine the user's nmh directory
^Current\-Folder:~^To find the default current folder
.fi
.SH "SEE ALSO"
.IR mhbuild (1),
.IR mhlist (1),
.IR mhshow (1),
.IR mhstore (1),
.IR mh-format (5)
.PP
.I "Proposed Standard for Message Encapsulation"
(RFC 934)
.SH DEFAULTS
.nf
.RB ` "\-delay\ 0" '
.RB ` "\-from localmbox" '
.fi
.SH CONTEXT
None