From: Pascal Volk <user@localhost.localdomain.org>
Date: Mon, 5 Aug 2013 15:52:52 +0000 (+0000)
Subject: man: Added doveadm-exec.1.
X-Git-Tag: 2.2.5~10
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=cae843989b30b6cf332749cb262df8f2967acdf5;p=thirdparty%2Fdovecot%2Fcore.git

man: Added doveadm-exec.1.
---

diff --git a/.hgignore b/.hgignore
index c5bb3ffd95..c78e8c7717 100644
--- a/.hgignore
+++ b/.hgignore
@@ -105,5 +105,5 @@ src/plugins/quota/quota-status
 
 syntax: regexp
 src/.*/test-[^\.]*$
-doc/man/doveadm-(altmove|auth|deduplicate|director|dump|expunge|fetch|flags|import|instance|index|force-resync|help|kick|log|mailbox|mount|move|penalty|purge|pw|quota|search|user|who)\.1$
+doc/man/doveadm-(altmove|auth|deduplicate|director|dump|exec|expunge|fetch|flags|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 742f9047f1..83614da490 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -18,6 +18,7 @@ nodist_man1_MANS = \
 	doveadm-deduplicate.1 \
 	doveadm-director.1 \
 	doveadm-dump.1 \
+	doveadm-exec.1 \
 	doveadm-expunge.1 \
 	doveadm-fetch.1 \
 	doveadm-flags.1 \
@@ -58,6 +59,7 @@ EXTRA_DIST = \
 	doveadm-deduplicate.1.in \
 	doveadm-director.1.in \
 	doveadm-dump.1.in \
+	doveadm-exec.1.in \
 	doveadm-expunge.1.in \
 	doveadm-fetch.1.in \
 	doveadm-flags.1.in \
@@ -89,4 +91,4 @@ CLEANFILES = $(nodist_man1_MANS)
 
 .1.in.1: $(man_includefiles) Makefile
 	$(SHELL) $(srcdir)/sed.sh $(srcdir) $(rundir) $(pkgsysconfdir) \
-		< $< > $@
+		$(pkglibexecdir) < $< > $@
diff --git a/doc/man/doveadm-exec.1.in b/doc/man/doveadm-exec.1.in
new file mode 100644
index 0000000000..9d2f8efd8b
--- /dev/null
+++ b/doc/man/doveadm-exec.1.in
@@ -0,0 +1,47 @@
+.\" Copyright (c) 2013 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-EXEC 1 "2013-08-05" "Dovecot v2.2" "Dovecot"
+.SH NAME
+doveadm\-exec \- easily execute commands from Dovecot\(aqs libexec_dir
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR doveadm " [" \-Dv "] " exec
+.IR binary " [" "binary arguments" ]
+.\"------------------------------------------------------------------------
+.SH DESCRIPTION
+This command allows administrators and local users to simply execute
+commands from within
+.IR libexec_dir .
+So for example a logged in system user could start a pre\-authenticated
+imap session, using the command:
+.BR "doveadm exec imap" .
+An administrator would use the command:
+.B "doveadm exec imap \-u"
+.IR username .
+.\"------------------------------------------------------------------------
+@INCLUDE:global-options@
+.\"------------------------------------------------------------------------
+.SH ARGUMENTS
+.TP
+.I binary
+the name of an executable located in
+.IR @pkglibexecdir@ .
+.\"-------------------------------------
+.TP
+.I binary arguments
+options and arguments, wich will be passed through to the
+.IR binary .
+.\"------------------------------------------------------------------------
+.SH EXAMPLE
+This example demonstrates how to deliver a message from a file to a
+user\(aqs mailbox.
+.sp
+.nf
+.B doveadm exec dovecot\-lda \-d user@example.net \(rs
+.B \-f admin@example.net < \(ti/stuff/welcome.msg
+.fi
+.\"------------------------------------------------------------------------
+@INCLUDE:reporting-bugs@
+.\"------------------------------------------------------------------------
+.SH SEE ALSO
+.BR doveadm (1),
+.BR dovecot\-lda (1)
\ No newline at end of file
diff --git a/doc/man/doveadm.1.in b/doc/man/doveadm.1.in
index 10608a4166..f1b23cc05b 100644
--- a/doc/man/doveadm.1.in
+++ b/doc/man/doveadm.1.in
@@ -1,5 +1,5 @@
 .\" Copyright (c) 2010-2013 Dovecot authors, see the included COPYING file
-.TH DOVEADM 1 "2013-08-02" "Dovecot v2.2" "Dovecot"
+.TH DOVEADM 1 "2013-08-05" "Dovecot v2.2" "Dovecot"
 .SH NAME
 doveadm \- Dovecot\(aqs administration utility
 .\"------------------------------------------------------------------------
@@ -44,6 +44,11 @@ and all its child processes.
 Manage Dovecot directors (if used by proxy servers).
 .\"-------------------------------------
 .TP
+.B doveadm exec
+.BR doveadm\-exec (1),
+Easily execute commands from Dovecot\(aqs libexec_dir.
+.\"-------------------------------------
+.TP
 .B doveadm instance
 .BR doveadm\-instance (1),
 Manage the list of running Dovecot instances.
diff --git a/doc/man/sed.sh b/doc/man/sed.sh
index 7bd3647336..6da39636e3 100644
--- a/doc/man/sed.sh
+++ b/doc/man/sed.sh
@@ -3,6 +3,7 @@
 SRCDIR="${1:-`pwd`}"
 RUNDIR="${2:-/usr/local/var/run/dovecot}"
 PKGSYSCONFDIR="${3:-/usr/local/etc/dovecot}"
+PKGLIBEXECDIR="${4:-/usr/local/libexec/dovecot}"
 
 sed -e "/^@INCLUDE:global-options@$/{
 		r ${SRCDIR}/global-options.inc
@@ -27,5 +28,7 @@ sed -e "/^@INCLUDE:global-options@$/{
 	-e "/^@INCLUDE:reporting-bugs@$/{
 		r ${SRCDIR}/reporting-bugs.inc
 		d
-	}" | sed -e "s|@pkgsysconfdir@|${PKGSYSCONFDIR}|" -e "s|@rundir@|${RUNDIR}|"
+	}" | sed -e "s|@pkgsysconfdir@|${PKGSYSCONFDIR}|" \
+	-e "s|@rundir@|${RUNDIR}|" \
+	-e "s|@pkglibexecdir@|${PKGLIBEXECDIR}|"