From 1fc71c05ba77d575752913a775a1ea4a9251b738 Mon Sep 17 00:00:00 2001 From: Pascal Volk Date: Sun, 17 Nov 2013 16:58:20 +0000 Subject: [PATCH] man: Added doveadm-batch.1. --- .hgignore | 2 +- doc/man/Makefile.am | 2 + doc/man/doveadm-batch.1.in | 88 ++++++++++++++++++++++++++++++++++++++ doc/man/doveadm.1.in | 5 +++ 4 files changed, 96 insertions(+), 1 deletion(-) create mode 100644 doc/man/doveadm-batch.1.in diff --git a/.hgignore b/.hgignore index c78e8c7717..6af00fbd34 100644 --- a/.hgignore +++ b/.hgignore @@ -105,5 +105,5 @@ src/plugins/quota/quota-status syntax: regexp src/.*/test-[^\.]*$ -doc/man/doveadm-(altmove|auth|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-(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 --git a/doc/man/Makefile.am b/doc/man/Makefile.am index b0f9068811..6629c93f2b 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -16,6 +16,7 @@ nodist_man1_MANS = \ doveadm.1 \ doveadm-altmove.1 \ doveadm-auth.1 \ + doveadm-batch.1 \ doveadm-deduplicate.1 \ doveadm-director.1 \ doveadm-dump.1 \ @@ -57,6 +58,7 @@ EXTRA_DIST = \ doveadm.1.in \ doveadm-altmove.1.in \ doveadm-auth.1.in \ + doveadm-batch.1.in \ doveadm-deduplicate.1.in \ doveadm-director.1.in \ doveadm-dump.1.in \ diff --git a/doc/man/doveadm-batch.1.in b/doc/man/doveadm-batch.1.in new file mode 100644 index 0000000000..11ca451411 --- /dev/null +++ b/doc/man/doveadm-batch.1.in @@ -0,0 +1,88 @@ +.\" Copyright (c) 2013 Dovecot authors, see the included COPYING file +.TH DOVEADM\-BATCH 1 "2013-11-17" "Dovecot v2.2" "Dovecot" +.SH NAME +doveadm\-batch \- Execute multiple commands for multiple users +.\"------------------------------------------------------------------------ +.SH SYNOPSIS +.BR doveadm " [" \-Dv "] " batch " [" \-S +.IR socket_path "] " +.BI \-A " sep command sep command" +[...] +.br +.\"------------------------------------- +.BR doveadm " [" \-Dv "] " batch " [" \-S +.IR socket_path "] " +.BI \-u " usermask sep command sep command" +[...] +.\"------------------------------------------------------------------------ +.SH DESCRIPTION +The command +.B doveadm batch +is used to execute multiple +.BR doveadm (1) +.IR command s +sequentially for multiple users. +This is primarily an optimization where Dovecot can do all the mailbox +operations for the same user at once, instead of having to go through +the users multiple times. +.PP +In the first form +.BR doveadm (1) +will loop over all users, defined in the configured +.IR user_db (s), +and execute the sequence of +.IR command s +for each of them. +.PP +In the second form the +.IR command s +will be executed for each user matching the given +.IR usermask . +.\"------------------------------------------------------------------------ +@INCLUDE:global-options@ +.\" --- command specific options --- "/. +.PP +Command specific +.IR options : +.\"------------------------------------- +@INCLUDE:option-A@ +.\"------------------------------------- +@INCLUDE:option-S-socket@ +.\"------------------------------------- +@INCLUDE:option-u-user@ +.\"------------------------------------------------------------------------ +.SH ARGUMENTS +.TP +.I command +Any +.BR doveadm (1) +command, with arguments and options \(em except for the +.BR \-A ", " \-S " and " \-u " options." +.\"------------------------------------- +.TP +.I sep +A single character used as command separator, e.g. \(aq:\(aq. +Be careful, unquoted characters, like +.BR ; " or " & , +may be interpreted by your shell and +.BR doveadm (1) +will never see them. +.\"------------------------------------------------------------------------ +.SH EXAMPLE +In this example we move seen mails, older than one month, for all +example.net users to the alternative storage under /nfsmount: +.br +.nf +mail_location = mdbox:~/mdbox:ALT=/nfsmount/%h/mdbox +.fi +The second command will remove messages with refcount=0 from the +primary storage. +.PP +.nf +.B doveadm batch \-u \(rs*@example.net : altmove seen savedbefore 30d : purge +.fi +.\"------------------------------------------------------------------------ +@INCLUDE:reporting-bugs@ +.\"------------------------------------------------------------------------ +.SH SEE ALSO +.BR doveadm (1) \ No newline at end of file diff --git a/doc/man/doveadm.1.in b/doc/man/doveadm.1.in index 7d2fc82f90..cc54dc46cc 100644 --- a/doc/man/doveadm.1.in +++ b/doc/man/doveadm.1.in @@ -102,6 +102,11 @@ Perform a user lookup in Dovecot\(aqs userdbs Move matching mails to the alternative storage. .\"------------------------------------- .TP +.B doveadm batch +.BR doveadm\-batch (1), +Execute multiple commands for multiple users. +.\"------------------------------------- +.TP .B doveadm copy .BR doveadm\-copy (1), Copy messages matching the given search query into another mailbox. -- 2.47.3