From: Michael Slusarz <michael.slusarz@dovecot.fi>
Date: Tue, 26 Apr 2016 20:27:39 +0000 (-0600)
Subject: man: Add stub for doveadm-fs command
X-Git-Tag: 2.3.0.rc1~3883
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=74780c1e28bebb2b8b0a2ee7376244030c2e043f;p=thirdparty%2Fdovecot%2Fcore.git

man: Add stub for doveadm-fs command
---

diff --git a/.gitignore b/.gitignore
index c88e9fbca8..f04ab421b2 100644
--- a/.gitignore
+++ b/.gitignore
@@ -60,6 +60,7 @@ doc/man/doveadm-exec.1
 doc/man/doveadm-expunge.1
 doc/man/doveadm-fetch.1
 doc/man/doveadm-flags.1
+doc/man/doveadm-fs.1
 doc/man/doveadm-fts.1
 doc/man/doveadm-import.1
 doc/man/doveadm-instance.1
diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 3bfaea3d23..6390ed769b 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -27,6 +27,7 @@ nodist_man1_MANS = \
 	doveadm-expunge.1 \
 	doveadm-fetch.1 \
 	doveadm-flags.1 \
+	doveadm-fs.1 \
 	doveadm-fts.1 \
 	doveadm-import.1 \
 	doveadm-instance.1 \
@@ -75,6 +76,7 @@ EXTRA_DIST = \
 	doveadm-expunge.1.in \
 	doveadm-fetch.1.in \
 	doveadm-flags.1.in \
+	doveadm-fs.1.in \
 	doveadm-fts.1.in \
 	doveadm-import.1.in \
 	doveadm-instance.1.in \
diff --git a/doc/man/doveadm-fs.1.in b/doc/man/doveadm-fs.1.in
new file mode 100644
index 0000000000..0c30f7d2f4
--- /dev/null
+++ b/doc/man/doveadm-fs.1.in
@@ -0,0 +1,93 @@
+.\" Copyright (c) 2016 Dovecot authors, see the included COPYING file
+.TH DOVEADM\-PROXY 1 "2016-04-26" "Dovecot v2.2" "Dovecot"
+.SH NAME
+doveadm\-fs \- Interact with the abstract mail storage filesystem
+.\"------------------------------------------------------------------------
+.SH SYNOPSIS
+.BR doveadm " [" \-Dv ]
+[\fB\-f\fP \fIformatter\fP]
+.BI fs \ command
+.RI [ ARGUMENTS ]
+.\"------------------------------------------------------------------------
+.SH DESCRIPTION
+The
+.B doveadm fs
+.I commands
+are used to abstractly interact with the storage backend defined in the
+Dovecot configuration. It allows access to the mailbox structure without
+needing to know details of how the storage backend is architected.
+.\"------------------------------------------------------------------------
+@INCLUDE:global-options-formatter@
+.\" --- command specific options --- "/.
+.PP
+This command uses by default the
+.B table
+output formatter.
+.\"------------------------------------------------------------------------
+.SH COMMANDS
+.SS fs copy
+.B doveadm fs copy
+.I fs-driver
+.I fs-args
+.I source-path
+.I dest-path
+.PP
+Copy source path to the destination path.
+.\"-------------------------------------
+.SS fs delete
+.B doveadm fs delete
+[\fB\-R\fP] [\fB\-n\fP \fIcount\fP]
+.I fs-driver
+.I fs-args
+.I path
+[\fIpath\fP ...]
+.PP
+Delete all data associated with the path provided.
+.\"-------------------------------------
+.SS fs get
+.B doveadm fs get
+.I fs-driver
+.I fs-args
+.I path
+.PP
+Retrieve data associated with the path provided.
+.\"-------------------------------------
+.SS fs iter
+.B doveadm fs iter
+.I fs-driver
+.I fs-args
+.I path
+.PP
+Iterate through all data files in the path provided.
+.\"-------------------------------------
+.SS fs iter-dirs
+.B doveadm fs iter-dirs
+.I fs-driver
+.I fs-args
+.I path
+.PP
+Iterate through all directories in the path provided.
+.\"-------------------------------------
+.SS fs put
+.B doveadm fs put
+[\fB\-h\fP \fIhash\fP]
+.I fs-driver
+.I fs-args
+.I input_path
+.I path
+.PP
+Store data at the path provided.
+.\"-------------------------------------
+.SS fs stat
+.B doveadm fs stat
+.I fs-driver
+.I fs-args
+.I path
+.PP
+Retrieve files status for the path provided. Currently, only the total size
+(in bytes) of the item is returned.
+.\"------------------------------------------------------------------------
+@INCLUDE:reporting-bugs@
+.\"------------------------------------------------------------------------
+.SH SEE ALSO
+.BR doveadm (1)