dovecot-2.2: man: Added description of option `-F file'.
dovecot at dovecot.org
dovecot at dovecot.org
Sat May 9 15:36:09 UTC 2015
details: http://hg.dovecot.org/dovecot-2.2/rev/c469d8f4cde7
changeset: 18604:c469d8f4cde7
user: Pascal Volk <user at localhost.localdomain.org>
date: Sat May 09 15:29:21 2015 +0000
description:
man: Added description of option `-F file'.
diffstat:
doc/man/Makefile.am | 1 +
doc/man/doveadm-acl.1.in | 22 ++++++++++++----------
doc/man/doveadm-altmove.1.in | 15 +++++++++++++--
doc/man/doveadm-batch.1.in | 17 +++++++++++++++--
doc/man/doveadm-deduplicate.1.in | 8 ++++++--
doc/man/doveadm-expunge.1.in | 18 ++++++++++++++++--
doc/man/doveadm-fetch.1.in | 11 ++++++++++-
doc/man/doveadm-flags.1.in | 21 +++++++++++++++++----
doc/man/doveadm-force-resync.1.in | 9 ++++++++-
doc/man/doveadm-fts.1.in | 8 +++++---
doc/man/doveadm-import.1.in | 16 ++++++++++++++--
doc/man/doveadm-index.1.in | 11 ++++++++++-
doc/man/doveadm-mailbox.1.in | 18 ++++++++++--------
doc/man/doveadm-move.1.in | 29 +++++++++++++++++++++++++++--
doc/man/doveadm-purge.1.in | 15 +++++++++++++--
doc/man/doveadm-quota.1.in | 20 +++++++++++++++++---
doc/man/doveadm-search.1.in | 17 +++++++++++++++--
doc/man/doveadm-sync.1.in | 8 +++++---
doc/man/option-F-file.inc | 15 +++++++++++++++
doc/man/option-u-user.inc | 4 +++-
doc/man/sed.sh | 4 ++++
21 files changed, 236 insertions(+), 51 deletions(-)
diffs (truncated from 904 to 300 lines):
diff -r e4b62ba0fb5a -r c469d8f4cde7 doc/man/Makefile.am
--- a/doc/man/Makefile.am Sat May 09 18:28:04 2015 +0300
+++ b/doc/man/Makefile.am Sat May 09 15:29:21 2015 +0000
@@ -56,6 +56,7 @@
$(srcdir)/global-options-formatter.inc \
$(srcdir)/global-options.inc \
$(srcdir)/option-A.inc \
+ $(srcdir)/option-F-file.inc \
$(srcdir)/option-S-socket.inc \
$(srcdir)/option-u-user.inc \
$(srcdir)/reporting-bugs.inc
diff -r e4b62ba0fb5a -r c469d8f4cde7 doc/man/doveadm-acl.1.in
--- a/doc/man/doveadm-acl.1.in Sat May 09 18:28:04 2015 +0300
+++ b/doc/man/doveadm-acl.1.in Sat May 09 15:29:21 2015 +0000
@@ -1,5 +1,5 @@
.\" Copyright (c) 2014-2015 Dovecot authors, see the included COPYING file
-.TH DOVEADM\-ACL 1 "2014-10-09" "Dovecot v2.2" "Dovecot"
+.TH DOVEADM\-ACL 1 "2015-05-09" "Dovecot v2.2" "Dovecot"
.SH NAME
doveadm\-acl \- Manage Access Control List (ACL)
.\"------------------------------------------------------------------------
@@ -26,6 +26,8 @@
.\"-------------------------------------
@INCLUDE:option-A@
.\"-------------------------------------
+ at INCLUDE:option-F-file@
+.\"-------------------------------------
@INCLUDE:option-S-socket@
.\"-------------------------------------
@INCLUDE:option-u-user@
@@ -80,7 +82,7 @@
.fi
.PP
Now if timo is a member of the tempdisabled group, he has no access to the
-mailbox.
+mailbox.
This wouldn\(aqt be possible with a normal group identifier, because the
.B user=timo
would override it.
@@ -171,7 +173,7 @@
.SH COMMANDS
.SS acl add
.B doveadm acl add
-[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP|\fB\-F\fP \fIfile\fP]
[\fB\-S\fP \fIsocket_path\fP]
.I mailbox id right
.RI [ right " ...]"
@@ -184,7 +186,7 @@
.\"-------------------------------------
.SS acl debug
.B doveadm acl debug
-[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP|\fB\-F\fP \fIfile\fP]
[\fB\-S\fP \fIsocket_path\fP]
.I mailbox
.PP
@@ -194,7 +196,7 @@
.\"-------------------------------------
.SS acl delete
.B doveadm acl delete
-[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP|\fB\-F\fP \fIfile\fP]
[\fB\-S\fP \fIsocket_path\fP]
.I mailbox id
.PP
@@ -203,7 +205,7 @@
.\"-------------------------------------
.SS acl get
.B doveadm acl get
-[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP|\fB\-F\fP \fIfile\fP]
[\fB\-S\fP \fIsocket_path\fP]
.RB [ \-m ]
.I mailbox
@@ -213,7 +215,7 @@
.\"-------------------------------------
.SS acl recalc
.B doveadm acl recalc
-[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP|\fB\-F\fP \fIfile\fP]
[\fB\-S\fP \fIsocket_path\fP]
.PP
Make sure the
@@ -223,7 +225,7 @@
.\"-------------------------------------
.SS acl remove
.B doveadm acl remove
-[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP|\fB\-F\fP \fIfile\fP]
[\fB\-S\fP \fIsocket_path\fP]
.I mailbox id right
.RI [ right " ...]"
@@ -234,7 +236,7 @@
.\"-------------------------------------
.SS acl rights
.B doveadm acl rights
-[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP|\fB\-F\fP \fIfile\fP]
[\fB\-S\fP \fIsocket_path\fP]
.I mailbox
.PP
@@ -245,7 +247,7 @@
.\"-------------------------------------
.SS acl set
.B doveadm acl set
-[\fB\-u\fP \fIuser\fP|\fB\-A\fP]
+[\fB\-u\fP \fIuser\fP|\fB\-A\fP|\fB\-F\fP \fIfile\fP]
[\fB\-S\fP \fIsocket_path\fP]
.I mailbox id right
.RI [ right " ...]"
diff -r e4b62ba0fb5a -r c469d8f4cde7 doc/man/doveadm-altmove.1.in
--- a/doc/man/doveadm-altmove.1.in Sat May 09 18:28:04 2015 +0300
+++ b/doc/man/doveadm-altmove.1.in Sat May 09 15:29:21 2015 +0000
@@ -1,5 +1,5 @@
.\" Copyright (c) 2010-2015 Dovecot authors, see the included COPYING file
-.TH DOVEADM\-ALTMOVE 1 "2014-10-19" "Dovecot v2.2" "Dovecot"
+.TH DOVEADM\-ALTMOVE 1 "2015-05-09" "Dovecot v2.2" "Dovecot"
.SH NAME
doveadm\-altmove \- Move matching mails to the alternative storage (dbox\-only)
.\"------------------------------------------------------------------------
@@ -15,6 +15,11 @@
.\"-------------------------------------
.BR doveadm " [" \-Dv "] " altmove " [" \-r "] ["\-S
.IR socket_path "] "
+.BI \-F " file search_query"
+.br
+.\"-------------------------------------
+.BR doveadm " [" \-Dv "] " altmove " [" \-r "] ["\-S
+.IR socket_path "] "
.BI \-u " user search_query"
.\"------------------------------------------------------------------------
.SH DESCRIPTION
@@ -30,7 +35,11 @@
.PP
In the second form, the command will be performed for all users.
.PP
-In the third form, only matching mails of the given
+In the third form, the command will be performed for all users listed in
+the given
+.IR file .
+.PP
+In the fourth form, only matching mails of the given
.IR user (s)
will be moved to the alternative storage.
.\"------------------------------------------------------------------------
@@ -42,6 +51,8 @@
.\"-------------------------------------
@INCLUDE:option-A@
.\"-------------------------------------
+ at INCLUDE:option-F-file@
+.\"-------------------------------------
.TP
.B \-r
When the
diff -r e4b62ba0fb5a -r c469d8f4cde7 doc/man/doveadm-batch.1.in
--- a/doc/man/doveadm-batch.1.in Sat May 09 18:28:04 2015 +0300
+++ b/doc/man/doveadm-batch.1.in Sat May 09 15:29:21 2015 +0000
@@ -1,5 +1,5 @@
.\" Copyright (c) 2013-2015 Dovecot authors, see the included COPYING file
-.TH DOVEADM\-BATCH 1 "2014-10-19" "Dovecot v2.2" "Dovecot"
+.TH DOVEADM\-BATCH 1 "2015-05-09" "Dovecot v2.2" "Dovecot"
.SH NAME
doveadm\-batch \- Execute multiple commands for multiple users
.\"------------------------------------------------------------------------
@@ -12,6 +12,12 @@
.\"-------------------------------------
.BR doveadm " [" \-Dv "] " batch " [" \-S
.IR socket_path "] "
+.BI \-F " file sep command sep command"
+[...]
+.br
+.\"-------------------------------------
+.BR doveadm " [" \-Dv "] " batch " [" \-S
+.IR socket_path "] "
.BI \-u " usermask sep command sep command"
[...]
.\"------------------------------------------------------------------------
@@ -34,7 +40,12 @@
.IR command s
for each of them.
.PP
-In the second form the
+In the second form
+.BR doveadm (1)
+will loop over all users, listed in the given
+.IR file .
+.PP
+In the third form the
.IR command s
will be executed for each user matching the given
.IR usermask .
@@ -47,6 +58,8 @@
.\"-------------------------------------
@INCLUDE:option-A@
.\"-------------------------------------
+ at INCLUDE:option-F-file@
+.\"-------------------------------------
@INCLUDE:option-S-socket@
.\"-------------------------------------
@INCLUDE:option-u-user@
diff -r e4b62ba0fb5a -r c469d8f4cde7 doc/man/doveadm-deduplicate.1.in
--- a/doc/man/doveadm-deduplicate.1.in Sat May 09 18:28:04 2015 +0300
+++ b/doc/man/doveadm-deduplicate.1.in Sat May 09 15:29:21 2015 +0000
@@ -1,12 +1,14 @@
.\" Copyright (c) 2013-2015 Dovecot authors, see the included COPYING file
-.TH DOVEADM\-DEDUPLICATE 1 "2014-10-19" "Dovecot v2.2" "Dovecot"
+.TH DOVEADM\-DEDUPLICATE 1 "2015-05-09" "Dovecot v2.2" "Dovecot"
.SH NAME
doveadm\-deduplicate \- expunge duplicate messages
.\"------------------------------------------------------------------------
.SH SYNOPSIS
.BR doveadm " [" \-Dv "] " deduplicate " [" \-u
.IR user |\c
-.BR \-A "] [" \-S
+.BR \-A |\c
+.BI \-F " file" \c
+.RB "] [" \-S
.IR socket_path "] ["\c
.BR \-m ]
.I search_query
@@ -31,6 +33,8 @@
.\"-------------------------------------
@INCLUDE:option-A@
.\"-------------------------------------
+ at INCLUDE:option-F-file@
+.\"-------------------------------------
@INCLUDE:option-S-socket@
.\"-------------------------------------
.TP
diff -r e4b62ba0fb5a -r c469d8f4cde7 doc/man/doveadm-expunge.1.in
--- a/doc/man/doveadm-expunge.1.in Sat May 09 18:28:04 2015 +0300
+++ b/doc/man/doveadm-expunge.1.in Sat May 09 15:29:21 2015 +0000
@@ -1,5 +1,5 @@
.\" Copyright (c) 2010-2015 Dovecot authors, see the included COPYING file
-.TH DOVEADM\-EXPUNGE 1 "2014-10-19" "Dovecot v2.2" "Dovecot"
+.TH DOVEADM\-EXPUNGE 1 "2015-05-09" "Dovecot v2.2" "Dovecot"
.SH NAME
doveadm\-expunge \- Expunge messages matching given search query
.\"------------------------------------------------------------------------
@@ -19,6 +19,12 @@
.BR doveadm " [" \-Dv "] " expunge " [" \-S
.IR socket_path ]
.RB [ \-d ]
+.BI \-F " file search_query"
+.br
+.\"-------------------------------------
+.BR doveadm " [" \-Dv "] " expunge " [" \-S
+.IR socket_path ]
+.RB [ \-d ]
.BI \-u " user search_query"
.\"------------------------------------------------------------------------
.SH DESCRIPTION
@@ -39,7 +45,13 @@
.PP
In the second form, the command will be performed for all users.
.PP
-In the third form, only matching mails of the given
+In the third form,
+.BR doveadm (1)
+will expunge messages of the users listed
+in the given
+.IR file .
+.PP
+In the fourth form, only matching mails of the given
.IR user (s)
will be expunged.
.\"------------------------------------------------------------------------
@@ -51,6 +63,8 @@
.\"-------------------------------------
@INCLUDE:option-A@
.\"-------------------------------------
+ at INCLUDE:option-F-file@
+.\"-------------------------------------
.TP
.B \-d
Delete the mailbox if it is empty after expunging.
diff -r e4b62ba0fb5a -r c469d8f4cde7 doc/man/doveadm-fetch.1.in
--- a/doc/man/doveadm-fetch.1.in Sat May 09 18:28:04 2015 +0300
+++ b/doc/man/doveadm-fetch.1.in Sat May 09 15:29:21 2015 +0000
@@ -1,5 +1,5 @@
.\" Copyright (c) 2010-2015 Dovecot authors, see the included COPYING file
-.TH DOVEADM\-FETCH 1 "2012-02-13" "Dovecot v2.2" "Dovecot"
+.TH DOVEADM\-FETCH 1 "2015-05-09" "Dovecot v2.2" "Dovecot"
.SH NAME
doveadm\-fetch \- Fetch partial/full messages or message information
.\"------------------------------------------------------------------------
@@ -21,6 +21,13 @@
.IR formatter ]
.BR fetch " [" \-S
.IR socket_path "]"
+.BI \-F " file fields search_query"
+.br
+.\"-------------------------------------
+.BR doveadm " [" \-Dv "] [" \-f
+.IR formatter ]
+.BR fetch " [" \-S
+.IR socket_path "]"
.BI \-u " user fields search_query"
.\"------------------------------------------------------------------------
More information about the dovecot-cvs
mailing list