dovecot-2.0: doc: added manual pages

dovecot at dovecot.org dovecot at dovecot.org
Mon Jun 28 17:22:09 EEST 2010


details:   http://hg.dovecot.org/dovecot-2.0/rev/be2b7d2901a0
changeset: 11644:be2b7d2901a0
user:      Pascal Volk <user at localhost.localdomain.org>
date:      Mon Jun 28 13:56:39 2010 +0000
description:
doc: added manual pages

diffstat:

 .hgignore                            |    2 +
 Makefile.am                          |    6 +-
 configure.in                         |    1 +
 doc/Makefile.am                      |    6 +-
 doc/man/Makefile.am                  |   68 ++++++
 doc/man/deliver.1                    |    1 +
 doc/man/doveadm-altmove.1.in         |   77 +++++++
 doc/man/doveadm-auth.1.in            |  112 +++++++++++
 doc/man/doveadm-director.1.in        |  181 ++++++++++++++++++
 doc/man/doveadm-dump.1.in            |   69 ++++++
 doc/man/doveadm-expunge.1.in         |   73 +++++++
 doc/man/doveadm-fetch.1.in           |  177 +++++++++++++++++
 doc/man/doveadm-force-resync.1.in    |   54 +++++
 doc/man/doveadm-help.1.in            |   36 +++
 doc/man/doveadm-kick.1.in            |  138 +++++++++++++
 doc/man/doveadm-log.1.in             |   99 +++++++++
 doc/man/doveadm-mailbox.1.in         |  279 +++++++++++++++++++++++++++
 doc/man/doveadm-penalty.1.in         |   55 +++++
 doc/man/doveadm-purge.1.in           |   55 +++++
 doc/man/doveadm-pw.1.in              |  142 ++++++++++++++
 doc/man/doveadm-quota.1.in           |  112 +++++++++++
 doc/man/doveadm-reload.1             |    1 +
 doc/man/doveadm-search-query.7       |  403 ++++++++++++++++++++++++++++++++++++++++
 doc/man/doveadm-search.1.in          |  105 ++++++++++
 doc/man/doveadm-stop.1               |    1 +
 doc/man/doveadm-user.1.in            |  147 ++++++++++++++
 doc/man/doveadm-who.1.in             |   93 +++++++++
 doc/man/doveadm.1.in                 |  169 ++++++++++++++++
 doc/man/doveconf.1.in                |  180 ++++++++++++++++++
 doc/man/dovecot-lda.1.in             |  153 +++++++++++++++
 doc/man/dovecot.1.in                 |  152 +++++++++++++++
 doc/man/dsync.1.in                   |  176 +++++++++++++++++
 doc/man/global-options-formatter.inc |   35 +++
 doc/man/global-options.inc           |   10 +
 doc/man/option-A.inc                 |   22 ++
 doc/man/option-u-user.inc            |   20 ++
 doc/man/reporting-bugs.inc           |    6 +
 doc/man/sed.sh                       |   27 ++
 38 files changed, 3437 insertions(+), 6 deletions(-)

diffs (truncated from 3626 to 300 lines):

diff -r 9be162cc2c52 -r be2b7d2901a0 .hgignore
--- a/.hgignore	Mon Jun 28 13:30:32 2010 +0100
+++ b/.hgignore	Mon Jun 28 13:56:39 2010 +0000
@@ -95,3 +95,5 @@
 
 syntax: regexp
 src/.*/test-[^\.]*$
+doc/man/doveadm-(altmove|auth|director|dump|expunge|fetch|force-resync|help|kick|log|mailbox|penalty|purge|pw|quota|search|user|who)\.1$
+doc/man/(doveadm|doveconf|dovecot-lda|dovecot|dsync)\.1$
diff -r 9be162cc2c52 -r be2b7d2901a0 Makefile.am
--- a/Makefile.am	Mon Jun 28 13:30:32 2010 +0100
+++ b/Makefile.am	Mon Jun 28 13:56:39 2010 +0000
@@ -1,13 +1,9 @@
 aclocaldir = $(datadir)/aclocal
 
-if BUILD_DOCS
-DOCS = doc
-endif
-
 SUBDIRS = \
 	. \
 	src \
-	$(DOCS)
+	doc
 
 dist_pkginclude_HEADERS = \
 	dovecot-version.h
diff -r 9be162cc2c52 -r be2b7d2901a0 configure.in
--- a/configure.in	Mon Jun 28 13:30:32 2010 +0100
+++ b/configure.in	Mon Jun 28 13:56:39 2010 +0000
@@ -2614,6 +2614,7 @@
 AC_CONFIG_FILES([
 Makefile
 doc/Makefile
+doc/man/Makefile
 doc/wiki/Makefile
 doc/example-config/Makefile
 doc/example-config/conf.d/Makefile
diff -r 9be162cc2c52 -r be2b7d2901a0 doc/Makefile.am
--- a/doc/Makefile.am	Mon Jun 28 13:30:32 2010 +0100
+++ b/doc/Makefile.am	Mon Jun 28 13:56:39 2010 +0000
@@ -1,4 +1,8 @@
-SUBDIRS = wiki example-config
+if BUILD_DOCS
+DOCDIRS = wiki example-config
+endif
+
+SUBDIRS = man $(DOCDIRS)
 
 docfiles = \
 	auth-protocol.txt \
diff -r 9be162cc2c52 -r be2b7d2901a0 doc/man/Makefile.am
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/man/Makefile.am	Mon Jun 28 13:56:39 2010 +0000
@@ -0,0 +1,68 @@
+dist_man1_MANS = \
+	deliver.1 \
+	doveadm-reload.1 \
+	doveadm-stop.1
+
+dist_man7_MANS = \
+	doveadm-search-query.7
+
+nodist_man1_MANS = \
+	doveadm.1 \
+	doveadm-altmove.1 \
+	doveadm-auth.1 \
+	doveadm-director.1 \
+	doveadm-dump.1 \
+	doveadm-expunge.1 \
+	doveadm-fetch.1 \
+	doveadm-force-resync.1 \
+	doveadm-help.1 \
+	doveadm-kick.1 \
+	doveadm-log.1 \
+	doveadm-mailbox.1 \
+	doveadm-penalty.1 \
+	doveadm-purge.1 \
+	doveadm-pw.1 \
+	doveadm-quota.1 \
+	doveadm-search.1 \
+	doveadm-user.1 \
+	doveadm-who.1 \
+	doveconf.1 \
+	dovecot.1 \
+	dovecot-lda.1 \
+	dsync.1
+
+EXTRA_DIST = \
+	doveadm.1.in \
+	doveadm-altmove.1.in \
+	doveadm-auth.1.in \
+	doveadm-director.1.in \
+	doveadm-dump.1.in \
+	doveadm-expunge.1.in \
+	doveadm-fetch.1.in \
+	doveadm-force-resync.1.in \
+	doveadm-help.1.in \
+	doveadm-kick.1.in \
+	doveadm-log.1.in \
+	doveadm-mailbox.1.in \
+	doveadm-penalty.1.in \
+	doveadm-purge.1.in \
+	doveadm-pw.1.in \
+	doveadm-quota.1.in \
+	doveadm-search.1.in \
+	doveadm-user.1.in \
+	doveadm-who.1.in \
+	doveconf.1.in \
+	dovecot.1.in \
+	dovecot-lda.1.in \
+	dsync.1.in \
+	global-options-formatter.inc \
+	global-options.inc \
+	option-A.inc \
+	option-u-user.inc \
+	reporting-bugs.inc \
+	sed.sh
+
+CLEANFILES = $(nodist_man1_MANS)
+
+%.1: $(srcdir)/%.1.in Makefile
+	$(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(sysconfdir) < $< > $@
diff -r 9be162cc2c52 -r be2b7d2901a0 doc/man/deliver.1
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/man/deliver.1	Mon Jun 28 13:56:39 2010 +0000
@@ -0,0 +1,1 @@
+.so man1/dovecot-lda.1
\ No newline at end of file
diff -r 9be162cc2c52 -r be2b7d2901a0 doc/man/doveadm-altmove.1.in
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/man/doveadm-altmove.1.in	Mon Jun 28 13:56:39 2010 +0000
@@ -0,0 +1,77 @@
+.\" Copyright (c) 2010 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-ALTMOVE 1 "2010-06-23" "Dovecot v2.0" "Dovecot"
+.SH NAME
+doveadm\-altmove \- Move matching mails to the alternative storage (dbox\-only)
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR doveadm " [" \-Dv "] " altmove
+.I search_query
+.br
+.\"-------------------------------------
+.BR doveadm " [" \-Dv "] " "altmove \-A"
+.I search_query
+.br
+.\"-------------------------------------
+.BR doveadm " [" \-Dv "] " "altmove \-u"
+.I user search_query
+.\"------------------------------------------------------------------------
+.SH DESCRIPTION
+This command can be used with dbox or mdbox storage to move mails to
+alternative storage path when :ALT=<path> is specified for the mail
+location.
+.PP
+In the first form,
+.BR doveadm (1)
+will executed the
+.B altmove
+action with the environment of the logged in system user.
+.PP
+In the second form, the command will be performed for all users.
+.PP
+In the third form, only matching mails of the given
+.IR user (s)
+will be moved to the alternative storage.
+.\"------------------------------------------------------------------------
+ at INCLUDE:global-options@
+.\" --- command specific options --- "/.
+.PP
+Command specific
+.IR options :
+.\"-------------------------------------
+ at INCLUDE:option-A@
+.\"-------------------------------------
+ at INCLUDE:option-u-user@
+.\"------------------------------------------------------------------------
+.SH ARGUMENTS
+.TP
+.I search_query
+Messages matching this search query will be moved to alt storage.
+See
+.BR doveadm\-search\-query (7)
+for details.
+.\"------------------------------------------------------------------------
+.SH FILES
+.TP
+.I @sysconfdir@/dovecot/conf.d/10\-mail.conf
+Mailbox locations and namespaces.
+.TP
+.I @sysconfdir@/dovecot/conf.d/auth\-*.conf.ext
+Authentication processes, including userdb settings.
+.\"------------------------------------------------------------------------
+.SH EXAMPLE
+This example moves seen mails older than one week to alternative storage
+under /nfsmount:
+.br
+.nf
+mail_location = mdbox:~/mdbox:ALT=/nfsmount/%h/mdbox
+.fi
+.PP
+.nf
+.B doveadm altmove \-u johnd at example.com seen savedbefore 1w
+.fi
+.\"------------------------------------------------------------------------
+ at INCLUDE:reporting-bugs@
+.\"------------------------------------------------------------------------
+.SH SEE ALSO
+.BR doveadm (1),
+.BR doveadm\-search\-query (7)
diff -r 9be162cc2c52 -r be2b7d2901a0 doc/man/doveadm-auth.1.in
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/man/doveadm-auth.1.in	Mon Jun 28 13:56:39 2010 +0000
@@ -0,0 +1,112 @@
+.\" Copyright (c) 2010 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-AUTH 1 "2010-06-09" "Dovecot v2.0" "Dovecot"
+.SH NAME
+doveadm\-auth \- Test authentication for a user
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR doveadm " [" \-Dv "] " auth
+[\fB\-a\fP \fIauth_socket_path\fP]
+[\fB\-x\fP \fIauth_info\fP]
+.I user
+[\fIpassword\fP]
+.\"------------------------------------------------------------------------
+.SH DESCRIPTION
+The
+.B auth
+command can be used to test the authentication for the given
+.IR user .
+.\"------------------------------------------------------------------------
+ at INCLUDE:global-options@
+.\" --- command specific options --- "/.
+.PP
+Command specific
+.IR options :
+.\"-------------------------------------
+.TP
+.BI \-a\  auth_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@/auth\-client .
+The socket may be located in another directory, when the default
+.I base_dir
+setting was overridden in
+.IR @sysconfdir@/dovecot/dovecot.conf .
+.\"-------------------------------------
+.TP
+.BI \-x\  auth_info
+.I auth_info
+specifies additional conditions for the
+.B auth
+command.
+The
+.I auth_info
+option string has to be given as
+.IB name = value
+pair.
+For multiple conditions the
+.B \-x
+option could be supplied multiple times.
+.br
+Possible names for the
+.I auth_info
+are:
+.RS
+.TP
+.B service
+The service for which the authentication lookup should be tested.
+The value may be the name of a service, commonly used with Dovecot.
+For example:
+.BR imap ,
+.BR pop3\  or
+.BR smtp .
+.TP
+.B lip
+The local IP address (server) for the test.
+.TP
+.B rip
+The remote IP address (client) for the test.
+.TP
+.B lport
+The local port, e.g. 143
+.TP
+.B rport
+The remote port, e.g. 24567
+.RE
+.\"------------------------------------------------------------------------
+.SH ARGUMENTS
+.\"-------------------------------------
+.TP
+.I user
+The
+.IR user \(aqs
+login name.


More information about the dovecot-cvs mailing list