From: Aki Tuomi <aki.tuomi@dovecot.fi>
Date: Thu, 24 Nov 2016 22:45:35 +0000 (+0200)
Subject: mail-crypt: Add manpage
X-Git-Tag: 2.2.27~34
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=c242e07d17365ba05ba3bbca8dd537bd7857d030;p=thirdparty%2Fdovecot%2Fcore.git

mail-crypt: Add manpage
---

diff --git a/.gitignore b/.gitignore
index a6bf607775..02381bd0b2 100644
--- a/.gitignore
+++ b/.gitignore
@@ -71,6 +71,7 @@ doc/man/doveadm-help.1
 doc/man/doveadm-kick.1
 doc/man/doveadm-log.1
 doc/man/doveadm-mailbox.1
+doc/man/doveadm-mailbox-cryptokey.1
 doc/man/doveadm-mount.1
 doc/man/doveadm-move.1
 doc/man/doveadm-penalty.1
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 6390ed769b..d1ff0bf4d0 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -38,6 +38,7 @@ nodist_man1_MANS = \
 	doveadm-log.1 \
 	doveadm-mailbox.1 \
 	doveadm-mount.1 \
+	doveadm-mailbox-cryptokey.1 \
 	doveadm-move.1 \
 	doveadm-penalty.1 \
 	doveadm-proxy.1 \
@@ -87,6 +88,7 @@ EXTRA_DIST = \
 	doveadm-log.1.in \
 	doveadm-mailbox.1.in \
 	doveadm-mount.1.in \
+	doveadm-mailbox-cryptokey.1.in \
 	doveadm-move.1.in \
 	doveadm-penalty.1.in \
 	doveadm-proxy.1.in \
diff --git a/doc/man/doveadm-mailbox-cryptokey.1.in b/doc/man/doveadm-mailbox-cryptokey.1.in
new file mode 100644
index 0000000000..795e92549e
--- /dev/null
+++ b/doc/man/doveadm-mailbox-cryptokey.1.in
@@ -0,0 +1,96 @@
+.\" Copyright (c) 2010-2016 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-MAILBOX\-CRYPTOKEY 1 "2016-01-12" "Dovecot v2.2" "Dovecot"
+.SH NAME
+doveadm\-mailbox\-cryptokey \- Mail crypt plugin management
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR doveadm " -o
+.IR plugin/mail_crypt_private_password=password "
+.BR [ " \-Dv " ] [ " \-f
+.IR formatter " ]
+.BR " mailbox cryptokey export|generate|list|password " [ " \-u
+.IR username
+.BR | " \-A " ] [ " \-S " ] [ " \-F "
+.IR file " ]
+.BR [ "
+.IR other "
+.IR options " ]
+.br
+.SH DESCRIPTION
+Generate new keypair for user or folder. The new keypair is marked as active.
+.SH OPTIONS
+.IR options :
+.\"-------------------------------------
+@INCLUDE:option-A@
+.\"-------------------------------------
+@INCLUDE:option-F-file@
+.\"-------------------------------------
+@INCLUDE:option-S-socket@
+.\"-------------------------------------
+@INCLUDE:option-u-user@
+.\"------------------------------------------------------------------------
+.TP
+.BI \-o\  plugin/mail_crypt_private_password=password
+Dovecot option, needed if you use password protected keys
+.SH SUBCOMMANDS
+.BR export " [ " \-U " ] " |
+.IR mailbox-mask 
+.TP
+.B \-U
+Operate on user keypair only
+.PP
+Exports user's or folder's keypair(s) in PEM format.
+If the keys are password protected, \-o is needed.
+.PP
+.\"------------------------------------------------------------------------
+.BR generate " [ " \-Rf "  [ " \-U " ] " | 
+.IR mailbox-mask " ]
+.TP
+.B \-U
+Operate on user keypair only
+.TP
+.BI \-R
+Re-encrypt all folder keys with current active user key
+.TP
+.B \-f
+Force keypair creation, normally keypair is only created if none found
+.PP
+Generates new keypair for user or folder. If you want to generate new user key
+and use it to secure your folder keys, use generate \-u username \-UR.
+.PP
+If you want to password-protect your key here, use \-o.
+.PP
+.\"------------------------------------------------------------------------
+.BR list " [ " \-U " ] " |
+.IR mailbox-mask
+.TP
+.B \-U
+Operate on user keypair only
+.PP
+List all keys for user or folder. No password is required.
+.PP
+.\"------------------------------------------------------------------------
+.BR password " [ " \-N " | " \-n
+.IR password " ]
+.BR " [ " \-O " | " \-o
+.IR password " ]
+.BR [ " \-C " ]
+.TP
+.B \-O
+Ask for old password
+.TP
+.BI \-o\ old-password
+Provide old password
+.TP
+.B \-N
+Ask for new password
+.TP
+.BI \-n\ new-password
+Provide new password
+.TP
+.B \-C
+Clear (unset/remove) password. Your key will not be protected by password.
+.PP
+Set, change or clear password from your user key.
+.SH SEE ALSO
+.BR doveadm(1)
diff --git a/doc/man/doveadm-mailbox.1.in b/doc/man/doveadm-mailbox.1.in
index ecd8b8cfb7..d098398ec7 100644
--- a/doc/man/doveadm-mailbox.1.in
+++ b/doc/man/doveadm-mailbox.1.in
@@ -64,6 +64,12 @@ When this
 option was given, the created mailboxes will be also added to the user\(aqs
 subscriptions.
 .\"------------------------------------------------------------------------
+.SS mailbox cryptokey
+.B mailbox cryptokey export|generate|list|password
+.PP
+This command is used to manage mail crypt plugin cryptographic keys.
+Please see doveadm-mailbox-cryptokey(1) for more details.
+.\"------------------------------------------------------------------------
 .SS mailbox delete
 .B doveadm mailbox delete
 [\fB\-A\fP|\fB\-u\fP \fIuser\fP|\fB\-F\fP \fIfile\fP]
@@ -319,3 +325,4 @@ doveadm mailbox mutf7 ~peter/mail/台北/日本語
 .\"------------------------------------------------------------------------
 .SH SEE ALSO
 .BR doveadm (1)
+.BR doveadm-mailbox-cryptokey(1)