changeset 12466:21966f298a3c

man: Added -s parameter.
author Pascal Volk <user@localhost.localdomain.org>
date Tue, 23 Nov 2010 18:42:27 +0000
parents e6076467fbf0
children 66428c763354
files doc/man/doveadm.1.in doc/man/global-options-formatter.inc doc/man/global-options.inc
diffstat 3 files changed, 24 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/doc/man/doveadm.1.in	Tue Nov 23 18:26:38 2010 +0000
+++ b/doc/man/doveadm.1.in	Tue Nov 23 18:42:27 2010 +0000
@@ -1,12 +1,13 @@
 .\" Copyright (c) 2010 Dovecot authors, see the included COPYING file
-.TH DOVEADM 1 "2010-07-01" "Dovecot v2.0" "Dovecot"
+.TH DOVEADM 1 "2010-11-23" "Dovecot v2.0" "Dovecot"
 .SH NAME
 doveadm \- Dovecot\(aqs administration utility
 .\"------------------------------------------------------------------------
 .SH SYNOPSIS
 .BR doveadm " [" \-Dv "] [" \-f
-.IR formatter ]
-.IR command " [" command_options "] [" command_arguments ]
+.IR formatter "] ["
+.BI \-s " socket_path
+.RI "] " command " [" command_options "] [" command_arguments ]
 .\"------------------------------------------------------------------------
 .SH DESCRIPTION
 .B doveadm
--- a/doc/man/global-options-formatter.inc	Tue Nov 23 18:26:38 2010 +0000
+++ b/doc/man/global-options-formatter.inc	Tue Nov 23 18:42:27 2010 +0000
@@ -31,5 +31,15 @@
 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	Tue Nov 23 18:26:38 2010 +0000
+++ b/doc/man/global-options.inc	Tue Nov 23 18:42:27 2010 +0000
@@ -6,5 +6,15 @@
 .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.