From af59148d4f60ccf9c958a9bc9aa1654d9462bd5e Mon Sep 17 00:00:00 2001 From: Pascal Volk Date: Sun, 5 Oct 2014 23:36:10 +0000 Subject: [PATCH] man: Added doveadm-replicator.1. --- .hgignore | 2 +- doc/man/Makefile.am | 2 + doc/man/doveadm-replicator.1.in | 123 ++++++++++++++++++++++++++++++++ doc/man/doveadm.1.in | 5 ++ 4 files changed, 131 insertions(+), 1 deletion(-) create mode 100644 doc/man/doveadm-replicator.1.in diff --git a/.hgignore b/.hgignore index 52fbe3148e..6ba2c8254b 100644 --- a/.hgignore +++ b/.hgignore @@ -105,5 +105,5 @@ src/plugins/quota/quota-status syntax: regexp src/.*/test-[^\.]*$ -doc/man/doveadm-(acl|altmove|auth|batch|deduplicate|director|dump|exec|expunge|fetch|flags|fts|import|instance|index|force-resync|help|kick|log|mailbox|mount|move|penalty|purge|pw|quota|search|sync|user|who)\.1$ +doc/man/doveadm-(acl|altmove|auth|batch|deduplicate|director|dump|exec|expunge|fetch|flags|fts|import|instance|index|force-resync|help|kick|log|mailbox|mount|move|penalty|purge|pw|quota|replicator|search|sync|user|who)\.1$ doc/man/(doveadm|doveconf|dovecot-lda|dovecot)\.1$ diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 7825644a81..461eed823f 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -42,6 +42,7 @@ nodist_man1_MANS = \ doveadm-purge.1 \ doveadm-pw.1 \ doveadm-quota.1 \ + doveadm-replicator.1 \ doveadm-search.1 \ doveadm-sync.1 \ doveadm-user.1 \ @@ -86,6 +87,7 @@ EXTRA_DIST = \ doveadm-purge.1.in \ doveadm-pw.1.in \ doveadm-quota.1.in \ + doveadm-replicator.1.in \ doveadm-search.1.in \ doveadm-sync.1.in \ doveadm-user.1.in \ diff --git a/doc/man/doveadm-replicator.1.in b/doc/man/doveadm-replicator.1.in new file mode 100644 index 0000000000..b36be6f74d --- /dev/null +++ b/doc/man/doveadm-replicator.1.in @@ -0,0 +1,123 @@ +.\" Copyright (c) 2014 Dovecot authors, see the included COPYING file +.TH DOVEADM\-REPLICATOR 1 "2014-10-05" "Dovecot v2.2" "Dovecot" +.SH NAME +doveadm\-replicator \- Manage users\(aq mail replicaton +.\"------------------------------------------------------------------------ +.SH SYNOPSIS +.BR doveadm " [" \-Dv ] +[\fB\-f\fP \fIformatter\fP] +.BI replicator \ command +.RI [ OPTIONS ]\ [ ARGUMENTS ] +.\"------------------------------------------------------------------------ +.SH DESCRIPTION +The +doveadm replicator +.I COMMANDS +can be used to manage the automated replication of users\(aq mail. +.\"------------------------------------------------------------------------ +@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 : +.TP +.BI \-a \ replicator_socket_path +This option is used to specify an absolute path to an alternative UNIX +domain socket. +.sp +By default +.BR doveadm (1) +will use the socket +.IR @rundir@/replicator\-doveadm . +The socket may be located in another directory, when the default +.I base_dir +setting was overridden in +.IR @pkgsysconfdir@/dovecot.conf . +.\"------------------------------------------------------------------------ +.SH ARGUMENTS +.TP +.I user_mask +Specifies for which users the command should be executed. +In most cases you would like to use patterns which contains wildcards, +e.g. \(rs*@example.net for all users of the example.net domain, or simply +\(rs* for all users. +.sp +When the SQL userdb module is used make sure that the +.I iterate_query +setting in +.I @pkgsysconfdir@/dovecot\-sql.conf.ext +matches your database layout. +When using the LDAP userdb module, make sure that the +.IR iterate_attrs " and " iterate_filter +settings in +.I @pkgsysconfdir@/dovecot\-ldap.conf.ext +match your LDAP schema. +Otherwise +.BR doveadm (1) +will be unable to iterate over all users. +.\"------------------------------------------------------------------------ +.SH COMMANDS +.SS replicator add +.B doveadm replicator add +[\fB\-a\fP \fIreplicator_socket_path\fP] +.I user_mask +.PP +Add the specified user(s) to the replicator. +If the +.I user_mask +contains \(dq?\(dq or \(dq*\(dq wildcards, the list of usernames is looked +up from the +.IR userdb . +.\"------------------------------------- +.SS replicator dsync\-status +.B doveadm replicator dsync\-status +[\fB\-a\fP \fIreplicator_socket_path\fP] +.PP +Show the status for the currently running dsync processes. +.\"------------------------------------- +.SS replicator remove +.B doveadm replicator remove +[\fB\-a\fP \fIreplicator_socket_path\fP] +.I username +.PP +Remove the specified user from replicator. +.\"------------------------------------- +.SS replicator replicate +.B doveadm replicator replicate +[\fB\-a\fP \fIreplicator_socket_path\fP] +.RB [ \-f ] +[\fB\-p\fP \fIpriority\fP] +.I user_mask +.PP +Start replication for the specified users now. +If the \-f parameter is given, full replication is done for the user. +You can also specify the priority, which can be either +.B high " or " low. +If the user mask contains \(dq?\(dq or \(dq*\(dq wildcards, the list of +usernames is looked up from the users that currently exist in replicator +(not from the +.IR userdb ). +.\"------------------------------------- +.SS replicator status +.B doveadm replicator status +[\fB\-a\fP \fIreplicator_socket_path\fP] +.I user_mask +.PP +Show the replication status for users. +.\"------------------------------------------------------------------------ +@INCLUDE:reporting-bugs@ +.\"------------------------------------------------------------------------ +.SH SEE ALSO +.BR doveadm (1), +.BR doveadm\-sync (1), +.\"------------------------------------- +.PP +Additional resources: +.IP "Replication with dsync" +http://wiki2.dovecot.org/Replication \ No newline at end of file diff --git a/doc/man/doveadm.1.in b/doc/man/doveadm.1.in index 82f1ba7d3e..5793a82c1f 100644 --- a/doc/man/doveadm.1.in +++ b/doc/man/doveadm.1.in @@ -187,6 +187,11 @@ Remove messages with refcount=0 from mdbox files. Initialize/recalculate or show current quota usage. .\"------------------------------------- .TP +.B doveadm replicator +.BR doveadm\-replicator (1), +Manage users\(aq mail replicaton. +.\"------------------------------------- +.TP .B doveadm sync .BR doveadm\-sync (1), Dovecot\(aqs two\-way mailbox synchronization utility. -- 2.47.3