dovecot-2.2: man: Added doveadm-acl.1.

dovecot at dovecot.org dovecot at dovecot.org
Wed Sep 24 19:54:43 UTC 2014 

details:   http://hg.dovecot.org/dovecot-2.2/rev/07cb8ad8b063
changeset: 17828:07cb8ad8b063
user:      Pascal Volk <user at localhost.localdomain.org>
date:      Wed Sep 24 19:50:37 2014 +0000
description:
man: Added doveadm-acl.1.

diffstat:

 .hgignore                |    2 +-
 doc/man/Makefile.am      |    2 +
 doc/man/doveadm-acl.1.in |  271 +++++++++++++++++++++++++++++++++++++++++++++++
 doc/man/doveadm.1.in     |    9 +-
 4 files changed, 281 insertions(+), 3 deletions(-)

diffs (truncated from 328 to 300 lines):

diff -r 4fc0fbed97f9 -r 07cb8ad8b063 .hgignore
--- a/.hgignore	Tue Sep 23 16:58:59 2014 +0300
+++ b/.hgignore	Wed Sep 24 19:50:37 2014 +0000
@@ -105,5 +105,5 @@
 
 syntax: regexp
 src/.*/test-[^\.]*$
-doc/man/doveadm-(altmove|auth|batch|deduplicate|director|dump|exec|expunge|fetch|flags|import|instance|index|force-resync|help|kick|log|mailbox|mount|move|penalty|purge|pw|quota|search|user|who)\.1$
+doc/man/doveadm-(acl|altmove|auth|batch|deduplicate|director|dump|exec|expunge|fetch|flags|import|instance|index|force-resync|help|kick|log|mailbox|mount|move|penalty|purge|pw|quota|search|user|who)\.1$
 doc/man/(doveadm|doveconf|dovecot-lda|dovecot|dsync)\.1$
diff -r 4fc0fbed97f9 -r 07cb8ad8b063 doc/man/Makefile.am
--- a/doc/man/Makefile.am	Tue Sep 23 16:58:59 2014 +0300
+++ b/doc/man/Makefile.am	Wed Sep 24 19:50:37 2014 +0000
@@ -14,6 +14,7 @@
 
 nodist_man1_MANS = \
 	doveadm.1 \
+	doveadm-acl.1 \
 	doveadm-altmove.1 \
 	doveadm-auth.1 \
 	doveadm-batch.1 \
@@ -56,6 +57,7 @@
 
 EXTRA_DIST = \
 	doveadm.1.in \
+	doveadm-acl.1.in \
 	doveadm-altmove.1.in \
 	doveadm-auth.1.in \
 	doveadm-batch.1.in \
diff -r 4fc0fbed97f9 -r 07cb8ad8b063 doc/man/doveadm-acl.1.in
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/man/doveadm-acl.1.in	Wed Sep 24 19:50:37 2014 +0000
@@ -0,0 +1,271 @@
+.\" Copyright (c) 2014 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-ACL 1 "2014-09-24" "Dovecot v2.2" "Dovecot"
+.SH NAME
+doveadm\-acl \- Manage Access Control List (ACL)
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR doveadm " [" \-Dv ]
+[\fB\-f\fP \fIformatter\fP]
+.BI acl \ command
+.RI [ OPTIONS ]\ [ ARGUMENTS ]
+.\"------------------------------------------------------------------------
+.SH DESCRIPTION
+The
+.B doveadm acl
+.I COMMANDS
+can be used to execute various Access Control List related actions.
+.\"------------------------------------------------------------------------
+ at INCLUDE:global-options-formatter@
+.\" --- command specific options --- "/.
+.PP
+This command uses by default the output formatter
+.B flow
+(without the
+.IR key =
+prefix).
+.PP
+Command specific
+.IR options :
+.\"-------------------------------------
+ at INCLUDE:option-A@
+.\"-------------------------------------
+ at INCLUDE:option-S-socket@
+.\"-------------------------------------
+ at INCLUDE:option-u-user@
+.\"------------------------------------------------------------------------
+.SH ARGUMENTS
+.TP
+.I id
+The id (identifier) is one of:
+.RS
+.RS
+.TP 4
+*
+.BR group\-override =\c
+.I group_name
+.\"-----------------
+.TP
+*
+.BR user =\c
+.I user_name
+.\"-----------------
+.TP
+*
+.B owner
+.\"-----------------
+.TP
+*
+.BR group =\c
+.I group_name
+.\"-----------------
+.TP
+*
+.B authenticated
+.\"-----------------
+.TP
+*
+.BR anyone " (or " anonymous ", which is an alias for anyone)"
+.\"-----------------
+.RE
+.PP
+The ACLs are processed in the precedence given above, so for example if you
+have given read\-access to a group, you can still remove that from specific
+users inside the group.
+.br
+Group\-override identifier allows you to override users\(aq ACLs.
+Probably the most useful reason to do this is to temporarily disable
+access for some users.
+For example:
+.PP
+.nf
+user=timo rw
+group\-override=tempdisabled
+.fi
+.PP
+Now if timo is a member of the tempdisabled group, he has no access to the
+mailbox. 
+This wouldn\(aqt be possible with a normal group identifier, because the
+.B user=timo
+would override it.
+.RE
+.\"-------------------------------------
+.TP
+.I mailbox
+The name of the mailbox, for which the ACL manipulation should be done.
+It\(aqs also possible to use the wildcard characters
+.RB \(dq * "\(dq and/or \(dq" ? \(dq
+in the mailbox name.
+.\"-------------------------------------
+.TP
+.I right
+Dovecot ACL right name. This isn\(aqt the same as the IMAP ACL letters,
+which aren\(aqt currently supported.
+Here is a mapping of the IMAP ACL letters to Dovecot ACL names:
+.RS
+.RS
+.TP 4
+.B l \(-> lookup
+.I Mailbox
+is visible in mailbox list.
+.I Mailbox
+can be subscribed to.
+.\"-----------------
+.TP
+.B r \(-> read
+.I Mailbox
+can be opened for reading.
+.\"-----------------
+.TP
+.B w \(-> write
+Message flags and keywords can be changed, except
+.BR \(rsSeen " and " \(rsDeleted .
+.\"-----------------
+.TP
+.B s \(-> write\-seen
+.B \(rsSeen
+flag can be changed.
+.\"-----------------
+.TP
+.B t \(-> write\-deleted
+.B \(rsDeleted
+flag can be changed.
+.\"-----------------
+.TP
+.B i \(-> insert
+Messages can be written or copied to the
+.IR mailbox .
+.\"-----------------
+.TP
+.B p \(-> post
+Messages can be posted to the
+.I mailbox
+by
+.BR dovecot\-lda ,
+e.g. from Sieve scripts.
+.\"-----------------
+.TP
+.B e \(-> expunge
+Messages can be expunged.
+.\"-----------------
+.TP
+.B k \(-> create
+Mailboxes can be created/renamed directly under this
+.I mailbox
+(but not necessarily under its children, see
+.I ACL Inheritance
+in the wiki).
+.br
+Note: Renaming also requires the delete right.
+.\"-----------------
+.TP
+.B x \(-> delete
+.I Mailbox
+can be deleted.
+.\"-----------------
+.TP
+.B a \(-> admin
+Administration rights to the
+.I mailbox
+(currently: ability to change ACLs for
+.IR mailbox ).
+.RE
+.RE
+.\"------------------------------------------------------------------------
+.SH COMMANDS
+.SS acl add
+.B doveadm acl add
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-S\fP \fIsocket_path\fP]
+.I mailbox id right
+.RI [ right " ...]"
+.PP
+Add ACL rights to the
+.IR mailbox / id .
+If the
+.I id
+already exists, the existing rights are preserved.
+.\"-------------------------------------
+.SS acl debug
+.B doveadm acl debug
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-S\fP \fIsocket_path\fP]
+.I mailbox
+.PP
+This command can be used to debug why a shared mailbox isn\(aqt
+accessible to the user.
+It will list exactly what the problem is.
+.\"-------------------------------------
+.SS acl delete
+.B doveadm acl delete
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-S\fP \fIsocket_path\fP]
+.I mailbox id
+.PP
+Remove the whole ACL entry for the
+.IR mailbox / id .
+.\"-------------------------------------
+.SS acl get
+.B doveadm acl get
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-S\fP \fIsocket_path\fP]
+.RB [ \-m ]
+.I mailbox
+.PP
+Show all the ACLs for the
+.IR mailbox .
+.\"-------------------------------------
+.SS acl recalc
+.B doveadm acl recalc
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-S\fP \fIsocket_path\fP]
+.PP
+Make sure the
+.IR user \(aqs
+shared mailboxes exist correctly in the
+.IR acl_shared_dict .
+.\"-------------------------------------
+.SS acl remove
+.B doveadm acl remove
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-S\fP \fIsocket_path\fP]
+.I mailbox id right
+.RI [ right " ...]"
+.PP
+Remove the specified ACL rights from the
+.IR mailbox / id .
+If all rights are removed, the entry still exists without any rights.
+.\"-------------------------------------
+.SS acl rights
+.B doveadm acl rights
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-S\fP \fIsocket_path\fP]
+.I mailbox
+.PP
+Show the
+.IR user \(aqs
+current ACL rights for the
+.IR mailbox .
+.\"-------------------------------------
+.SS acl set
+.B doveadm acl set
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-S\fP \fIsocket_path\fP]
+.I mailbox id right
+.RI [ right " ...]"
+.PP
+Set ACL rights to the
+.IR mailbox / id .
+If the
+.I id
+already exists, the existing rights are replaced.
+.\"------------------------------------------------------------------------
+ at INCLUDE:reporting-bugs@
+.\"------------------------------------------------------------------------
+.SH SEE ALSO
+.BR doveadm (1),
+.BR dovecot\-lda (1)
+.\"-------------------------------------

More information about the dovecot-cvs mailing list