summaryrefslogtreecommitdiff
path: root/sendmailadvanced.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'sendmailadvanced.1.in')
-rw-r--r--sendmailadvanced.1.in53
1 files changed, 53 insertions, 0 deletions
diff --git a/sendmailadvanced.1.in b/sendmailadvanced.1.in
new file mode 100644
index 0000000..9dd1312
--- /dev/null
+++ b/sendmailadvanced.1.in
@@ -0,0 +1,53 @@
+.TH sendmailadvanced 8 "" "sendmailadvanced #VERSION#" ""
+.SH NAME
+sendmailadvanced \- wrapper for sendmail which encrypts and generates stamps
+.SH SYNOPSIS
+\fBsendmailadvanced [options]\fP
+.SH DESCRIPTION
+\fBsendmailadvanced\fP encrypts emails and generates stamps either in situ or in a pipe. For that it uses \fBhashcash\fP and \fBgnupg\fP.
+.SH OPTIONS
+.TP
+.B "\-h, \-\-hook"
+Activate specified hook.
+.TP
+.B "\-i, \-\-inline"
+Enhance email file in situ.
+\fB\-\-inline \-\fP has the same effect as option \fB\-t\fP.
+Conflicts with \fB\-t, \-\-no\-inline\fP.
+.TP
+.B "\-t, \-\-no\-inline"
+Enhance email from stdin to stdout.
+Conflicts with \fB\-i, \-\-inline\fP.
+.TP
+.B "\-e, \-\-[no\-]encrypt"
+Do (not) encrypt.
+.TP
+.B "\-s, \-\-[no\-]stamp"
+Do (not) stamp.
+.SH CONFIGURATION
+The configfile \fB#ETCDIR#/sendmailadvanced.conf\fP is a bash script, which defines the following variables and routines:
+.TP
+.B "gpg_recipient"
+default recipient to encrypt to
+.TP
+.B "hashcash_bits"
+stamp value
+.TP
+.B "body_header_hook"
+routine printing things to put into head of (body of) email.
+Parameter \fB$1\fP was given on the console via \fB--hook $1\fP.
+.TP
+.B "body_footer_hook"
+routine printing things to put into foot of email.
+Parameter \fB$1\fP was given on the console via \fB--hook $1\fP.
+.SH FILES
+.TP
+.B "#BINDIR#/sendmailadvanced"
+program file
+.TP
+.B "#ETCDIR#/sendmailadvanced.conf"
+contains configuration
+.SH AUTHOR
+.nf
+Erich Eckner <opensource at eckner dot net>
+.fi