From: Timo Sirainen Date: Thu, 16 Feb 2012 16:31:57 +0000 (+0200) Subject: man: Added doveadm-instance(1) and doveadm-mount(1) X-Git-Tag: 2.1.1~24^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e0579d45910f8a4ed55aa670f136db183344a786;p=thirdparty%2Fdovecot%2Fcore.git man: Added doveadm-instance(1) and doveadm-mount(1) roff'ification by Pascal Volk. --- diff --git a/.hgignore b/.hgignore index 71a9fe5ea2..163a5b3ff0 100644 --- a/.hgignore +++ b/.hgignore @@ -98,5 +98,5 @@ src/plugins/quota/rquota.h syntax: regexp src/.*/test-[^\.]*$ -doc/man/doveadm-(altmove|auth|director|dump|expunge|fetch|import|index|force-resync|help|kick|log|mailbox|move|penalty|purge|pw|quota|search|user|who)\.1$ +doc/man/doveadm-(altmove|auth|director|dump|expunge|fetch|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 202275a3c9..d085d08ac3 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -18,12 +18,14 @@ nodist_man1_MANS = \ doveadm-expunge.1 \ doveadm-fetch.1 \ doveadm-import.1 \ + doveadm-instance.1 \ doveadm-index.1 \ doveadm-force-resync.1 \ doveadm-help.1 \ doveadm-kick.1 \ doveadm-log.1 \ doveadm-mailbox.1 \ + doveadm-mount.1 \ doveadm-move.1 \ doveadm-penalty.1 \ doveadm-purge.1 \ @@ -54,12 +56,14 @@ EXTRA_DIST = \ doveadm-expunge.1.in \ doveadm-fetch.1.in \ doveadm-import.1.in \ + doveadm-instance.1.in \ doveadm-index.1.in \ doveadm-force-resync.1.in \ doveadm-help.1.in \ doveadm-kick.1.in \ doveadm-log.1.in \ doveadm-mailbox.1.in \ + doveadm-mount.1.in \ doveadm-move.1.in \ doveadm-penalty.1.in \ doveadm-purge.1.in \ @@ -109,6 +113,10 @@ doveadm-import.1: $(srcdir)/doveadm-import.1.in $(man_includefiles) Makefile $(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \ < $(srcdir)/doveadm-import.1.in > doveadm-import.1 +doveadm-instance.1: $(srcdir)/doveadm-instance.1.in $(man_includefiles) Makefile + $(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \ + < $(srcdir)/doveadm-instance.1.in > doveadm-instance.1 + doveadm-index.1: $(srcdir)/doveadm-index.1.in $(man_includefiles) Makefile $(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \ < $(srcdir)/doveadm-index.1.in > doveadm-index.1 @@ -133,6 +141,10 @@ doveadm-mailbox.1: $(srcdir)/doveadm-mailbox.1.in $(man_includefiles) Makefile $(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \ < $(srcdir)/doveadm-mailbox.1.in > doveadm-mailbox.1 +doveadm-mount.1: $(srcdir)/doveadm-mount.1.in $(man_includefiles) Makefile + $(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \ + < $(srcdir)/doveadm-mount.1.in > doveadm-mount.1 + doveadm-move.1: $(srcdir)/doveadm-move.1.in $(man_includefiles) Makefile $(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \ < $(srcdir)/doveadm-move.1.in > doveadm-move.1 diff --git a/doc/man/doveadm-instance.1.in b/doc/man/doveadm-instance.1.in new file mode 100644 index 0000000000..c7915e9e5b --- /dev/null +++ b/doc/man/doveadm-instance.1.in @@ -0,0 +1,63 @@ +.\" Copyright (c) 2012 Dovecot authors, see the included COPYING file +.TH DOVEADM\-INSTANCE 1 "2012-02-16" "Dovecot v2.1" "Dovecot" +.SH NAME +doveadm\-instance \- Manage the list of running Dovecot instances +.\"------------------------------------------------------------------------ +.SH SYNOPSIS +.BR doveadm " [" \-Dv "] [" \-f +.IR formatter ] +.B instance list +.br +.BR doveadm " [" \-Dv "] " "instance remove" +.IR name " | " base_dir +.\"------------------------------------------------------------------------ +.SH DESCRIPTION +The +.B doveadm instance +commands are used to manage the list of Dovecot instances running on the +server. +In most installations there is only one Dovecot instance, but in some cases +is may be useful to have more (e.g. running director proxy and backend in +the same server). +.PP +Instances are added to the list automatically when Dovecot is started. +Each instance is uniquely identified by its +.I base_dir +setting. +Instances can be named by setting +.I instance_name +in each instance\(aqs +.IR dovecot.conf . +When an instance is named, it can be accessed easily by giving +.BI \-i\ instance_name +command line parameter for Dovecot binaries (e.g. doveadm). +.\"------------------------------------------------------------------------ +@INCLUDE:global-options-formatter@ +.\"------------------------------------------------------------------------ +.SH ARGUMENTS +.TP +.I name +The value of an instance\(aqs +.I instance_name +setting. +.\"------------------------------------- +.TP +.I base_dir +The base directory of a Dovecot instance. +.\"------------------------------------------------------------------------ +.SH COMMANDS +.SS instance list +.B doveadm instance list +.PP +This command lists the seen Dovecot instances. +.\"------------------------------------- +.SS instance remove +.B doveadm instance remove +.IR name " | " base_dir +.PP +This command removes the specified instance. +.\"------------------------------------------------------------------------ +@INCLUDE:reporting-bugs@ +.\"------------------------------------------------------------------------ +.SH SEE ALSO +.BR doveadm (1) \ No newline at end of file diff --git a/doc/man/doveadm-mount.1.in b/doc/man/doveadm-mount.1.in new file mode 100644 index 0000000000..8631a91ebd --- /dev/null +++ b/doc/man/doveadm-mount.1.in @@ -0,0 +1,94 @@ +.\" Copyright (c) 2012 Dovecot authors, see the included COPYING file +.TH DOVEADM\-MOUNT 1 "2012-02-16" "Dovecot v2.1" "Dovecot" +.SH NAME +doveadm\-mount \- Manage the list of mountpoints where mails are stored +.\"------------------------------------------------------------------------ +.SH SYNOPSIS +.BR doveadm " [" \-Dv "] [" \-f +.IR formatter ] +.B mount +.IR command " [" arguments ] +.\"------------------------------------------------------------------------ +.SH DESCRIPTION +The doveadm +.B mount +.IR command s +can be used to manage the list of mountpoints where mails are stored. +This is used mainly for better error handling when a mountpoint isn\(aqt +mounted for some reason: +.TP 4 +* +If a mail directory doesn\(aqt exist, it\(aqs autocreated. +If the user\(aqs mails aren\(aqt mounted and filesystem permissions still +allow the autocreation, the user will see an empty mailbox and later will +have to redownload all mails. +If the mountpoint is known to be unmounted, Dovecot will simply fail +opening any mailboxes. +.TP +* +If dbox alternate storage isn\(aqt mounted and a mail in it is attempted to +be accessed, Dovecot normally rebuilds the indexes and notices that all the +mails in alt storage are expunged. +When the alt storage is mounted back and even if index is again rebuilt, +the mails won\(aqt necessarily become visible anymore for IMAP clients. +If the mountpoint is known to be unmounted, Dovecot won\(aqt rebuild +indexes and lose the mails. +.PP +Dovecot automatically adds mountpoints to this list at startup. +If you don\(aqt want some of the mountpoints added, you can add a wildcard +ignore for it. +.\"------------------------------------------------------------------------ +@INCLUDE:global-options-formatter@ +.\"------------------------------------------------------------------------ +.SH ARGUMENTS +.TP +.I path +The directory name of a mountpoint +.\"------------------------------------- +.TP +.I state +The +.I state +of a mountpoint. +Either +.BR online " or " ignore . +.\"------------------------------------------------------------------------ +.SH COMMANDS +.SS mount add +.B doveadm mount add +.RI [ path " [" state ]] +.PP +If this command is run without any parameters, doveadm detects all missing +mountpoints and adds them (the same way as when Dovecot does at startup). +.PP +When a mountpoint +.I path +is given, it\(aqs added as a mountpoint. +The +.I state +can currently be either +.RB \(dq online \(dq +(default) or +.RB \(dq ignore \(dq. +The ignore state is mainly useful with path wildcards to add mountpoints +that you never want Dovecot to automatically add, such as: +.B doveadm mount add '/mnt/*' ignore +.\"------------------------------------- +.SS mount list +.BR doveadm " [" \-Dv " ] [" \-f +.IR formatter ] +.B mount list +.PP +This command lists the mountpoints known to Dovecot and their state. +.\"------------------------------------- +.SS mount remove +.BI "doveadm mount remove " path +.PP +This command removes the specified +.I path +from the mountpoint list. +.\"------------------------------------------------------------------------ +@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 e4f7301d19..14f5acd048 100644 --- a/doc/man/doveadm.1.in +++ b/doc/man/doveadm.1.in @@ -112,11 +112,21 @@ Repair broken mailboxes, in case Dovecot doesn\(aqt automatically do that. Import messages matching given search query. .\"------------------------------------- .TP +.B doveadm instance +.BR doveadm\-instance (1), +Various commands related to handling Dovecot instances. +.\"------------------------------------- +.TP .B doveadm index .BR doveadm\-index (1), Index messages in a given mailbox. .\"------------------------------------- .TP +.B doveadm mount +.BR doveadm\-mount (1), +Various commands related to handling mail storage mountpoints. +.\"------------------------------------- +.TP .B doveadm mailbox .BR doveadm\-mailbox (1), Various commands related to handling mailboxes.