Mercurial > dovecot > core-2.2
changeset 12471:fee02c0565e7
man: Added "-S socket_path" description.
author | Pascal Volk <user@localhost.localdomain.org> |
---|---|
date | Thu, 25 Nov 2010 17:44:02 +0000 |
parents | 17a67be8edb5 |
children | 3abefa63b8e7 |
files | doc/man/Makefile.am doc/man/doveadm-altmove.1.in doc/man/doveadm-expunge.1.in doc/man/doveadm-fetch.1.in doc/man/doveadm-force-resync.1.in doc/man/doveadm-import.1.in doc/man/doveadm-mailbox.1.in doc/man/doveadm-purge.1.in doc/man/doveadm-quota.1.in doc/man/doveadm-search.1.in doc/man/doveadm.1.in doc/man/global-options-formatter.inc doc/man/global-options.inc doc/man/option-S-socket.inc doc/man/sed.sh |
diffstat | 15 files changed, 125 insertions(+), 86 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/man/Makefile.am Wed Nov 24 18:56:48 2010 +0000 +++ b/doc/man/Makefile.am Thu Nov 25 17:44:02 2010 +0000 @@ -39,6 +39,7 @@ $(srcdir)/global-options-formatter.inc \ $(srcdir)/global-options.inc \ $(srcdir)/option-A.inc \ + $(srcdir)/option-S-socket.inc \ $(srcdir)/option-u-user.inc \ $(srcdir)/reporting-bugs.inc
--- a/doc/man/doveadm-altmove.1.in Wed Nov 24 18:56:48 2010 +0000 +++ b/doc/man/doveadm-altmove.1.in Thu Nov 25 17:44:02 2010 +0000 @@ -1,19 +1,21 @@ .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file -.TH DOVEADM\-ALTMOVE 1 "2010-06-23" "Dovecot v2.0" "Dovecot" +.TH DOVEADM\-ALTMOVE 1 "2010-11-25" "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 doveadm " [" \-Dv "] " altmove " [" \-S +.IR socket_path "] " search_query .br .\"------------------------------------- -.BR doveadm " [" \-Dv "] " "altmove \-A" -.I search_query +.BR doveadm " [" \-Dv "] " altmove " [" \-S +.IR socket_path "] " +.BI \-A " search_query" .br .\"------------------------------------- -.BR doveadm " [" \-Dv "] " "altmove \-u" -.I user search_query +.BR doveadm " [" \-Dv "] " altmove " [" \-S +.IR socket_path "] " +.BI \-u " user search_query" .\"------------------------------------------------------------------------ .SH DESCRIPTION This command can be used with sdbox or mdbox storage to move mails to @@ -40,6 +42,8 @@ .\"------------------------------------- @INCLUDE:option-A@ .\"------------------------------------- +@INCLUDE:option-S-socket@ +.\"------------------------------------- @INCLUDE:option-u-user@ .\"------------------------------------------------------------------------ .SH ARGUMENTS @@ -74,4 +78,4 @@ .\"------------------------------------------------------------------------ .SH SEE ALSO .BR doveadm (1), -.BR doveadm\-search\-query (7) +.BR doveadm\-search\-query (7) \ No newline at end of file
--- a/doc/man/doveadm-expunge.1.in Wed Nov 24 18:56:48 2010 +0000 +++ b/doc/man/doveadm-expunge.1.in Thu Nov 25 17:44:02 2010 +0000 @@ -1,19 +1,21 @@ .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file -.TH DOVEADM\-EXPUNGE 1 "2010-06-23" "Dovecot v2.0" "Dovecot" +.TH DOVEADM\-EXPUNGE 1 "2010-11-25" "Dovecot v2.0" "Dovecot" .SH NAME doveadm\-expunge \- Expunge messages matching given search query .\"------------------------------------------------------------------------ .SH SYNOPSIS -.BR doveadm " [" \-Dv "] " expunge -.I search_query +.BR doveadm " [" \-Dv "] " expunge " [" \-S +.IR socket_path "] " search_query .br .\"------------------------------------- -.BR doveadm " [" \-Dv "] " "expunge \-A" -.I search_query +.BR doveadm " [" \-Dv "] " expunge " [" \-S +.IR socket_path "] " +.BI \-A " search_query" .br .\"------------------------------------- -.BR doveadm " [" \-Dv "] " "expunge \-u" -.I user search_query +.BR doveadm " [" \-Dv "] " expunge " [" \-S +.IR socket_path "] " +.BI \-u " user search_query" .\"------------------------------------------------------------------------ .SH DESCRIPTION This command can be used to expunge mails matching the given search query. @@ -45,6 +47,8 @@ .\"------------------------------------- @INCLUDE:option-A@ .\"------------------------------------- +@INCLUDE:option-S-socket@ +.\"------------------------------------- @INCLUDE:option-u-user@ .\"------------------------------------------------------------------------ .SH ARGUMENTS @@ -70,4 +74,4 @@ .BR doveadm\-fetch (1), .BR doveadm\-purge (1), .BR doveadm\-search (1), -.BR doveadm\-search\-query (7) +.BR doveadm\-search\-query (7) \ No newline at end of file
--- a/doc/man/doveadm-fetch.1.in Wed Nov 24 18:56:48 2010 +0000 +++ b/doc/man/doveadm-fetch.1.in Thu Nov 25 17:44:02 2010 +0000 @@ -1,25 +1,27 @@ .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file -.TH DOVEADM\-FETCH 1 "2010-06-26" "Dovecot v2.0" "Dovecot" +.TH DOVEADM\-FETCH 1 "2010-11-25" "Dovecot v2.0" "Dovecot" .SH NAME doveadm\-fetch \- Fetch partial/full messages or message information .\"------------------------------------------------------------------------ .SH SYNOPSIS .BR doveadm " [" \-Dv "] [" \-f .IR formatter ] -.B fetch -.I fields search_query +.BR fetch " [" \-S +.IR socket_path "] " "fields search_query" .br .\"------------------------------------- .BR doveadm " [" \-Dv "] [" \-f .IR formatter ] -.B fetch \-A -.I fields search_query +.BR fetch " [" \-S +.IR socket_path "]" +.BI \-A " fields search_query" .br .\"------------------------------------- .BR doveadm " [" \-Dv "] [" \-f .IR formatter ] -.B fetch \-u -.I user fields search_query +.BR fetch " [" \-S +.IR socket_path "]" +.BI \-u " user fields search_query" .\"------------------------------------------------------------------------ .SH DESCRIPTION .B doveadm fetch @@ -41,6 +43,8 @@ .\"------------------------------------- @INCLUDE:option-A@ .\"------------------------------------- +@INCLUDE:option-S-socket@ +.\"------------------------------------- @INCLUDE:option-u-user@ .\"------------------------------------------------------------------------ .SH ARGUMENTS @@ -174,4 +178,4 @@ .SH SEE ALSO .BR doveadm (1), .BR doveadm\-search (1), -.BR doveadm\-search\-query (7) +.BR doveadm\-search\-query (7) \ No newline at end of file
--- a/doc/man/doveadm-force-resync.1.in Wed Nov 24 18:56:48 2010 +0000 +++ b/doc/man/doveadm-force-resync.1.in Thu Nov 25 17:44:02 2010 +0000 @@ -1,19 +1,21 @@ .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file -.TH DOVEADM\-FORCE\-RESYNC 1 "2010-06-22" "Dovecot v2.0" "Dovecot" +.TH DOVEADM\-FORCE\-RESYNC 1 "2010-11-25" "Dovecot v2.0" "Dovecot" .SH NAME doveadm\-force\-resync \- Repair broken mailboxes .\"------------------------------------------------------------------------ .SH SYNOPSIS -.BR doveadm " [" \-Dv "] " force\-resync -.I mailbox +.BR doveadm " [" \-Dv "] " force\-resync " [" \-S +.IR socket_path "] " mailbox .\"------------------------------------- .br -.BR doveadm " [" \-Dv "] " "force\-resync \-A" -.I mailbox +.BR doveadm " [" \-Dv "] " force\-resync " [" \-S +.IR socket_path "] " +.BI \-A \ mailbox .\"------------------------------------- .br -.BR doveadm " [" \-Dv "] " "force\-resync \-u" -.I user mailbox +.BR doveadm " [" \-Dv "] " force\-resync " [" \-S +.IR socket_path "] " +.BI \-u " user mailbox" .\"------------------------------------------------------------------------ .SH DESCRIPTION Under certain circumstances it may happen, that @@ -33,6 +35,8 @@ .\"------------------------------------- @INCLUDE:option-A@ .\"------------------------------------- +@INCLUDE:option-S-socket@ +.\"------------------------------------- @INCLUDE:option-u-user@ .\"------------------------------------------------------------------------ .SH ARGUMENTS @@ -51,4 +55,4 @@ @INCLUDE:reporting-bugs@ .\"------------------------------------------------------------------------ .SH SEE ALSO -.BR doveadm (1) +.BR doveadm (1) \ No newline at end of file
--- a/doc/man/doveadm-import.1.in Wed Nov 24 18:56:48 2010 +0000 +++ b/doc/man/doveadm-import.1.in Thu Nov 25 17:44:02 2010 +0000 @@ -1,19 +1,21 @@ .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file -.TH DOVEADM\-IMPORT 1 "2010-11-23" "Dovecot v2.0" "Dovecot" +.TH DOVEADM\-IMPORT 1 "2010-11-25" "Dovecot v2.0" "Dovecot" .SH NAME doveadm\-import \- Import messages matching given search query .\"------------------------------------------------------------------------ .SH SYNOPSIS -.BR doveadm " [" \-Dv "] " import -.I source_location dest_parent search_query +.BR doveadm " [" \-Dv "] " import " [" \-S +.IR socket_path "] " "source_location dest_parent search_query" .br .\"------------------------------------- -.BR doveadm " [" \-Dv "] " "import \-A" -.I source_location dest_parent search_query +.BR doveadm " [" \-Dv "] " import " [" \-S +.IR socket_path "] " +.BI \-A " source_location dest_parent search_query" .br .\"------------------------------------- -.BR doveadm " [" \-Dv "] " "import \-u" -.I user source_location dest_parent search_query +.BR doveadm " [" \-Dv "] " import " [" \-S +.IR socket_path "] " +.BI \-u " user source_location dest_parent search_query" .\"------------------------------------------------------------------------ .SH DESCRIPTION This command can be used to import mails from another mail storage specified by @@ -46,6 +48,8 @@ .\"------------------------------------- @INCLUDE:option-A@ .\"------------------------------------- +@INCLUDE:option-S-socket@ +.\"------------------------------------- @INCLUDE:option-u-user@ .\"------------------------------------------------------------------------ .SH ARGUMENTS @@ -80,4 +84,4 @@ .BR doveadm (1), .BR doveadm\-fetch (1), .BR doveadm\-search (1), -.BR doveadm\-search\-query (7) +.BR doveadm\-search\-query (7) \ No newline at end of file
--- a/doc/man/doveadm-mailbox.1.in Wed Nov 24 18:56:48 2010 +0000 +++ b/doc/man/doveadm-mailbox.1.in Thu Nov 25 17:44:02 2010 +0000 @@ -1,5 +1,5 @@ .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file -.TH DOVEADM\-MAILBOX 1 "2010-06-22" "Dovecot v2.0" "Dovecot" +.TH DOVEADM\-MAILBOX 1 "2010-11-25" "Dovecot v2.0" "Dovecot" .SH NAME doveadm\-mailbox \- Commands related to handling mailboxes .\"------------------------------------------------------------------------ @@ -19,6 +19,8 @@ .\"------------------------------------- @INCLUDE:option-A@ .\"------------------------------------- +@INCLUDE:option-S-socket@ +.\"------------------------------------- @INCLUDE:option-u-user@ .\"------------------------------------------------------------------------ .SH ARGUMENTS @@ -38,6 +40,7 @@ .SS mailbox create .B doveadm mailbox create [\fB\-A\fP|\fB\-u\fP \fIuser\fP] +[\fB\-S\fP \fIsocket_path\fP] .RB [ \-s ] .IR mailbox\ ... .PP @@ -56,6 +59,7 @@ .SS mailbox delete .B doveadm mailbox delete [\fB\-A\fP|\fB\-u\fP \fIuser\fP] +[\fB\-S\fP \fIsocket_path\fP] .RB [ \-s ] .IR mailbox\ ... .PP @@ -70,6 +74,7 @@ .B doveadm mailbox list .RB [ \-7 | \-8 ] [\fB\-A\fP|\fB\-u\fP \fIuser\fP] +[\fB\-S\fP \fIsocket_path\fP] .RB [ \-s ] [\fImailbox\fP ...] .PP @@ -124,6 +129,7 @@ .SS mailbox rename .B doveadm mailbox rename [\fB\-A\fP|\fB\-u\fP \fIuser\fP] +[\fB\-S\fP \fIsocket_path\fP] .RB [ \-s ] .I old_name .I new_name @@ -148,7 +154,8 @@ .BR doveadm " [" \-f .IR formatter ] .B mailbox status -[\fB\-A\fP|\fB\-u\fP \fIuser\fP] [\fB\-t\fP] +[\fB\-A\fP|\fB\-u\fP \fIuser\fP] +[\fB\-S\fP \fIsocket_path\fP] [\fB\-t\fP] .IR "fields mailbox\ " ... .PP Show the @@ -230,6 +237,7 @@ .SS mailbox subscribe .B doveadm mailbox subscribe [\fB\-A\fP|\fB\-u\fP \fIuser\fP] +[\fB\-S\fP \fIsocket_path\fP] .IR mailbox\ ... .PP This command is used to subscribe one or more mailboxes. @@ -237,6 +245,7 @@ .SS mailbox unsubscribe .B doveadm mailbox unsubscribe [\fB\-A\fP|\fB\-u\fP \fIuser\fP] +[\fB\-S\fP \fIsocket_path\fP] .IR mailbox\ ... .PP This command is used to unsubscribe one or more mailboxes. @@ -276,4 +285,4 @@ @INCLUDE:reporting-bugs@ .\"------------------------------------------------------------------------ .SH SEE ALSO -.BR doveadm (1) +.BR doveadm (1) \ No newline at end of file
--- a/doc/man/doveadm-purge.1.in Wed Nov 24 18:56:48 2010 +0000 +++ b/doc/man/doveadm-purge.1.in Thu Nov 25 17:44:02 2010 +0000 @@ -1,17 +1,21 @@ .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file -.TH DOVEADM\-PURGE 1 "2010-06-22" "Dovecot v2.0" "Dovecot" +.TH DOVEADM\-PURGE 1 "2010-11-25" "Dovecot v2.0" "Dovecot" .SH NAME doveadm\-purge \- Remove messages with refcount=0 from mdbox files .\"------------------------------------------------------------------------ .SH SYNOPSIS -.BR doveadm " [" \-Dv "] " purge +.BR doveadm " [" \-Dv "] " purge " [" \-S +.IR socket_path "] " .\"------------------------------------- .br -.BR doveadm " [" \-Dv "] " "purge \-A" +.BR doveadm " [" \-Dv "] " purge " [" \-S +.IR socket_path ] +.B \-A .\"------------------------------------- .br -.BR doveadm " [" \-Dv "] " "purge \-u" -.I user +.BR doveadm " [" \-Dv "] " purge " [" \-S +.IR socket_path "] " +.BI \-u \ user .\"------------------------------------------------------------------------ .SH DESCRIPTION The @@ -42,8 +46,9 @@ .\"------------------------------------- @INCLUDE:option-A@ .\"------------------------------------- +@INCLUDE:option-S-socket@ +.\"------------------------------------- @INCLUDE:option-u-user@ - .\"------------------------------------------------------------------------ @INCLUDE:reporting-bugs@ .\"------------------------------------------------------------------------ @@ -52,4 +57,4 @@ .BR doveadm\-expunge (1) .PP See http://wiki2.dovecot.org/MailboxFormat/dbox#Multi\-dbox for some -details. +details. \ No newline at end of file
--- a/doc/man/doveadm-quota.1.in Wed Nov 24 18:56:48 2010 +0000 +++ b/doc/man/doveadm-quota.1.in Thu Nov 25 17:44:02 2010 +0000 @@ -1,25 +1,27 @@ .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file -.TH DOVEADM\-QUOTA 1 "2010-06-23" "Dovecot v2.0" "Dovecot" +.TH DOVEADM\-QUOTA 1 "2010-11-25" "Dovecot v2.0" "Dovecot" .SH NAME doveadm\-quota \- Initialize/recalculate or show current quota usage .\"------------------------------------------------------------------------ .SH SYNOPSIS .BR doveadm " [" \-Dv "] [" \-f .IR formatter ] -.B quota -.I command +.BR quota " [" \-S +.IR socket_path "] " command .\"------------------------------------- .br .BR doveadm " [" \-Dv "] [" \-f .IR formatter ] -.B quota +.BR quota " [" \-S +.IR socket_path "]" .IB command\ \-A .\"------------------------------------- .br .BR doveadm " [" \-Dv "] [" \-f .IR formatter ] -.BI quota\ command\ \-u -.I user +.BR quota " [" \-S +.IR socket_path "]" +.IB command\ \-u \ user .\"------------------------------------------------------------------------ .SH DESCRIPTION In the first form, @@ -55,6 +57,8 @@ .\"------------------------------------- @INCLUDE:option-A@ .\"------------------------------------- +@INCLUDE:option-S-socket@ +.\"------------------------------------- @INCLUDE:option-u-user@ .\"------------------------------------------------------------------------ .SH COMMANDS
--- a/doc/man/doveadm-search.1.in Wed Nov 24 18:56:48 2010 +0000 +++ b/doc/man/doveadm-search.1.in Thu Nov 25 17:44:02 2010 +0000 @@ -1,5 +1,5 @@ .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file -.TH DOVEADM\-SEARCH 1 "2010-06-26" "Dovecot v2.0" "Dovecot" +.TH DOVEADM\-SEARCH 1 "2010-11-25" "Dovecot v2.0" "Dovecot" .SH NAME doveadm\-search \- Show a list of mailbox GUIDs and message UIDs matching \ given search query. @@ -7,17 +7,22 @@ .SH SYNOPSIS .BR doveadm " [" \-Dv "] [" \-f .IR formatter ] -.BI search\ search_query +.BR search " [" \-S +.IR socket_path "] " search_query .br .\"------------------------------------- .BR doveadm " [" \-Dv "] [" \-f .IR formatter ] -.BI "search \-A " search_query +.BR search " [" \-S +.IR socket_path ] +.BI \-A \ search_query .br .\"------------------------------------- .BR doveadm " [" \-Dv "] [" \-f .IR formatter ] -.BI "search \-u " "user search_query" +.BR search " [" \-S +.IR socket_path ] +.BI \-u " user search_query" .\"------------------------------------------------------------------------ .SH DESCRIPTION The @@ -64,6 +69,8 @@ .\"------------------------------------- @INCLUDE:option-A@ .\"------------------------------------- +@INCLUDE:option-S-socket@ +.\"------------------------------------- @INCLUDE:option-u-user@ .\"------------------------------------------------------------------------ .SH ARGUMENTS @@ -102,4 +109,4 @@ .SH SEE ALSO .BR doveadm (1), .BR doveadm\-fetch (1), -.BR doveadm\-search\-query (7) +.BR doveadm\-search\-query (7) \ No newline at end of file
--- a/doc/man/doveadm.1.in Wed Nov 24 18:56:48 2010 +0000 +++ b/doc/man/doveadm.1.in Thu Nov 25 17:44:02 2010 +0000 @@ -1,13 +1,12 @@ .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file -.TH DOVEADM 1 "2010-11-23" "Dovecot v2.0" "Dovecot" +.TH DOVEADM 1 "2010-11-25" "Dovecot v2.0" "Dovecot" .SH NAME doveadm \- Dovecot\(aqs administration utility .\"------------------------------------------------------------------------ .SH SYNOPSIS .BR doveadm " [" \-Dv "] [" \-f -.IR formatter "] [" -.BI \-s " socket_path -.RI "] " command " [" command_options "] [" command_arguments ] +.IR formatter ] +.IR command " [" command_options "] [" command_arguments ] .\"------------------------------------------------------------------------ .SH DESCRIPTION .B doveadm @@ -169,4 +168,4 @@ .BR doveconf (1), .BR dovecot (1), .BR dsync (1), -.BR doveadm\-search\-query (7) +.BR doveadm\-search\-query (7) \ No newline at end of file
--- a/doc/man/global-options-formatter.inc Wed Nov 24 18:56:48 2010 +0000 +++ b/doc/man/global-options-formatter.inc Thu Nov 25 17:44:02 2010 +0000 @@ -31,15 +31,5 @@ prints a table header followed by adjusted value lines. .RE .TP -.BI \-s\ socket_path -The option\(aqs argument is either an absolute path to a local UNIX domain -socket, or a hostname and port -.RI ( hostname : port ), -in order to connect a remote host via a TCP socket. -.sp -This allows an administrator to execute -.B doveadm mail -commands through the given socket. -.TP .B \-v Enables verbosity, including progress counter.
--- a/doc/man/global-options.inc Wed Nov 24 18:56:48 2010 +0000 +++ b/doc/man/global-options.inc Thu Nov 25 17:44:02 2010 +0000 @@ -6,15 +6,5 @@ .B \-D Enables verbosity and debug messages. .TP -.BI \-s\ socket_path -The option\(aqs argument is either an absolute path to a local UNIX domain -socket, or a hostname and port -.RI ( hostname : port ), -in order to connect a remote host via a TCP socket. -.sp -This allows an administrator to execute -.B doveadm mail -commands through the given socket. -.TP .B \-v Enables verbosity, including progress counter.
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/man/option-S-socket.inc Thu Nov 25 17:44:02 2010 +0000 @@ -0,0 +1,10 @@ +.TP +.BI \-S\ socket_path +The option\(aqs argument is either an absolute path to a local UNIX domain +socket, or a hostname and port +.RI ( hostname : port ), +in order to connect a remote host via a TCP socket. +.sp +This allows an administrator to execute +.BR doveadm (1) +mail commands through the given socket.
--- a/doc/man/sed.sh Wed Nov 24 18:56:48 2010 +0000 +++ b/doc/man/sed.sh Thu Nov 25 17:44:02 2010 +0000 @@ -16,6 +16,10 @@ r ${SRCDIR}/option-A.inc d }" \ + -e "/^@INCLUDE:option-S-socket@$/{ + r ${SRCDIR}/option-S-socket.inc + d + }" \ -e "/^@INCLUDE:option-u-user@$/{ r ${SRCDIR}/option-u-user.inc d