A mail formatter.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

133 lines
2.6 KiB

.TH FMAIL 1 2019-01-12 "fmail @PACKAGE_VERSION@"
.SH NAME
fmail \- mail formatter
.SH SYNOPSIS
.SY fmail
.RB [ \-h | --help ]
.RB [ \-v | --version ]
.RB [ \-a | --attach
.IR file ]
.RB [ \-s | --sign ]
.RB [ \-E | --encrypt
.IR recipient ]
.RB [ \-e | --edit ]
.RB [ \-f | --footer
.IR file ]
.RB [ \-H | --header
.IR header ]
.RB [ \-F | --from
.IR sender ]
.RB [ \-T | --to
.IR recipient ]
.RB [ \-C | --cc
.IR recipient ]
.RB [ \-S | --subject
.IR subject ]
.RB [ \-U | --user-agent ]
.RB [ \-D | --date ]
.YS
.SH DESCRIPTION
.PP
.B fmail
formats text read on standard input into a mail message
ready to be sent to a mail submission agent.
.PP
The formatting process includes: encoding the text body in
.I Quoted-Printable\fR;
creating appropriate MIME parts for attachments and
OpenPGP signature; encoding attachments (in
.I Base64
or
.I Quoted-Printable
depending on their type); adding appropriate mail headers;
and encrypting to one or several OpenPGP public keys.
.PP
The resulting message is printed on standard output and can
be piped directly to a program such as
.B sendmail(8)
to effectively send the message to a mail server.
.PP
The first lines of the input message, up to the first blank
line, are treated as mail headers; everything from the first
blank line to the end of file is treated as the mail body.
.SH OPTIONS
.TP
.BR -h ", " --help
Display the help message.
.TP
.BR -v ", " --version
Display the version message.
.TP
.BR -a ", " --attach " " \fIfile\fR
Attach the specified
.I file\fR.
.TP
.BR -s ", " --sign
Sign the message.
.TP
.BR -E ", " --encrypt " " \fIrecipient\fR
Encrypt the message to the public key of
the specified recipient.
.TP
.BR -e ", " --edit
Fire an editor to type the mail body instead of
reading it from standard input.
.TP
.BR -f ", " --footer " " \fIfile\fR
Append the contents of the specified
.I file
as the mail footer.
.TP
.BR -H ", " --header " " \fIheader\fR
Add an arbitrary header.
.TP
.BR -F ", " --from " " \fIsender\fR
Set the
.B From:
header.
.TP
.BR -T ", " --to " " \fIrecipient\fR
Add a
.B To:
header.
.TP
.BR -C ", " --cc " " \fIrecipient\fR
Add a
.B Cc:
header.
.TP
.BR -S ", " --subject " " \fIsubject\fR
Set the
.B Subject:
header.
.TP
.BR -U ", " --user-agent
Add a
.B User-Agent:
header.
.TP
.BR -D ", " --date
Add an automatically generated
.B Date:
header with the current date.
.SH REPORTING BUGS
.PP
Report bugs to
.MT @PACKAGE_BUGREPORT@
Damien Goutte-Gattat
.ME .
.SH COPYRIGHT
.ad l
.PP
Copyright \(co 2011,2018,2019 Damien Goutte-Gattat
.PP
This program is released under the GNU General Public License.
See the COPYING file in the source distribution or
.UR http://www.gnu.org/licenses/gpl.html
.UE .