From: Aki Tuomi <aki.tuomi@dovecot.fi>
Date: Thu, 11 May 2017 06:24:57 +0000 (+0300)
Subject: doc: Add manpage for doveadm-save
X-Git-Tag: 2.3.0.rc1~1637
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8d392e181c38e4ccd49567742cca71133ff12890;p=thirdparty%2Fdovecot%2Fcore.git

doc: Add manpage for doveadm-save
---

diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 4b65b2d11c..390c83d0ea 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -45,6 +45,7 @@ nodist_man1_MANS = \
 	doveadm-pw.1 \
 	doveadm-quota.1 \
 	doveadm-replicator.1 \
+	doveadm-save.1 \
 	doveadm-search.1 \
 	doveadm-stats.1 \
 	doveadm-sync.1 \
@@ -94,6 +95,7 @@ EXTRA_DIST = \
 	doveadm-pw.1.in \
 	doveadm-quota.1.in \
 	doveadm-replicator.1.in \
+	doveadm-save.1.in \
 	doveadm-search.1.in \
 	doveadm-stats.1.in \
 	doveadm-sync.1.in \
diff --git a/doc/man/doveadm-save.1.in b/doc/man/doveadm-save.1.in
new file mode 100644
index 0000000000..c3660d2202
--- /dev/null
+++ b/doc/man/doveadm-save.1.in
@@ -0,0 +1,66 @@
+.\" Copyright (c) 2017 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-SAVE 1 "2017-05-11" "Dovecot v2.2" "Dovecot"
+.SH NAME
+doveadm\-save \- Save email to a user's mailbox
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR doveadm " [" \-Dv "]
+.BR save " [" \-S
+.IR socket_path "]"
+.BI \-u " user "
+.RI "["\-m
+.IR mailbox "] "
+.RI "[" mail-file "]"
+.br
+.\"------------------------------------------------------------------------
+.BR doveadm " [" \-Dv "]
+.BR save " [" \-S
+.IR socket_path "]"
+.BI \-A
+.RI "["\-m
+.IR mailbox "] "
+.RI "[" mail-file "]"
+.br
+.\"------------------------------------------------------------------------
+.BR doveadm " [" \-Dv "] [" \-f
+.IR formatter ]
+.BR save " [" \-S
+.IR socket_path "]"
+.BI \-F " file "
+.RI "["\-m
+.IR mailbox "] "
+.RI "[" mail-file "]"
+.br
+.\"------------------------------------------------------------------------
+.SH DESCRIPTION
+.B doveadm save
+can be used to save messages. This can be useful for scripts and for debugging.
+Sieve is not invoked for saved messages, but quota is enforced.
+.\"------------------------------------------------------------------------
+@INCLUDE:global-options@
+.\" --- command specific options --- "/.
+.PP
+Command specific
+.IR options :
+.\"-------------------------------------
+@INCLUDE:option-A@
+.\"-------------------------------------
+@INCLUDE:option-F-file@
+.\"-------------------------------------
+@INCLUDE:option-S-socket@
+.\"-------------------------------------
+@INCLUDE:option-u-user@
+.\"-------------------------------------
+.TP
+.BI \-m\  mailbox
+Store mail to specified mailbox instead of INBOX.
+.\"------------------------------------------------------------------------
+.SH EXAMPLE
+echo "hello, world" | doveadm save -u testuser@testdomain
+.\"------------------------------------------------------------------------
+@INCLUDE:reporting-bugs@
+.\"------------------------------------------------------------------------
+.SH SEE ALSO
+.BR doveadm (1),
+.BR doveadm\-search (1),
+.BR doveadm\-search\-query (7)