summaryrefslogtreecommitdiffstats
path: root/doc/man/doveadm-exec.1.in
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/doveadm-exec.1.in')
-rw-r--r--doc/man/doveadm-exec.1.in47
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/man/doveadm-exec.1.in b/doc/man/doveadm-exec.1.in
new file mode 100644
index 0000000..dd4757c
--- /dev/null
+++ b/doc/man/doveadm-exec.1.in
@@ -0,0 +1,47 @@
+.\" Copyright (c) 2013-2018 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-EXEC 1 "2013-08-05" "Dovecot v2.3" "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, which 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