Mercurial > dovecot > core-2.2

annotate doc/man/doveadm-fs.1.in @ 22560:9a300e778b20

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
director: When logging "ring SYNC lost", include sync seq number in message This can help with debugging.
author Timo Sirainen <timo.sirainen@dovecot.fi>
date Thu, 14 Sep 2017 17:26:39 +0300
parents 2e2563132d5f
children cb108f786fb4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
21390
2e2563132d5f Updated copyright notices to include the year 2017.
Stephan Bosch <stephan.bosch@dovecot.fi>
parents: 20117
diff changeset
1 .\" Copyright (c) 2016-2017 Dovecot authors, see the included COPYING file
20117
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
2 .TH DOVEADM\-PROXY 1 "2016-04-26" "Dovecot v2.2" "Dovecot"
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
3 .SH NAME
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
4 doveadm\-fs \- Interact with the abstract mail storage filesystem
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
5 .\"------------------------------------------------------------------------
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
6 .SH SYNOPSIS
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
7 .BR doveadm " [" \-Dv ]
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
8 [\fB\-f\fP \fIformatter\fP]
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
9 .BI fs \ command
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
10 .RI [ ARGUMENTS ]
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
11 .\"------------------------------------------------------------------------
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
12 .SH DESCRIPTION
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
13 The
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
14 .B doveadm fs
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
15 .I commands
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
16 are used to abstractly interact with the storage backend defined in the
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
17 Dovecot configuration. It allows access to the mailbox structure without
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
18 needing to know details of how the storage backend is architected.
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
19 .\"------------------------------------------------------------------------
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
20 @INCLUDE:global-options-formatter@
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
21 .\" --- command specific options --- "/.
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
22 .PP
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
23 This command uses by default the
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
24 .B table
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
25 output formatter.
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
26 .\"------------------------------------------------------------------------
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
27 .SH COMMANDS
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
28 .SS fs copy
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
29 .B doveadm fs copy
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
30 .I fs-driver
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
31 .I fs-args
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
32 .I source-path
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
33 .I dest-path
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
34 .PP
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
35 Copy source path to the destination path.
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
36 .\"-------------------------------------
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
37 .SS fs delete
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
38 .B doveadm fs delete
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
39 [\fB\-R\fP] [\fB\-n\fP \fIcount\fP]
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
40 .I fs-driver
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
41 .I fs-args
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
42 .I path
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
43 [\fIpath\fP ...]
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
44 .PP
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
45 Delete all data associated with the path provided.
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
46 .\"-------------------------------------
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
47 .SS fs get
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
48 .B doveadm fs get
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
49 .I fs-driver
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
50 .I fs-args
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
51 .I path
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
52 .PP
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
53 Retrieve data associated with the path provided.
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
54 .\"-------------------------------------
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
55 .SS fs iter
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
56 .B doveadm fs iter
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
57 .I fs-driver
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
58 .I fs-args
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
59 .I path
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
60 .PP
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
61 Iterate through all data files in the path provided.
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
62 .\"-------------------------------------
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
63 .SS fs iter-dirs
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
64 .B doveadm fs iter-dirs
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
65 .I fs-driver
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
66 .I fs-args
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
67 .I path
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
68 .PP
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
69 Iterate through all directories in the path provided.
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
70 .\"-------------------------------------
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
71 .SS fs put
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
72 .B doveadm fs put
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
73 [\fB\-h\fP \fIhash\fP]
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
74 .I fs-driver
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
75 .I fs-args
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
76 .I input_path
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
77 .I path
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
78 .PP
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
79 Store data at the path provided.
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
80 .\"-------------------------------------
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
81 .SS fs stat
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
82 .B doveadm fs stat
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
83 .I fs-driver
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
84 .I fs-args
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
85 .I path
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
86 .PP
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
87 Retrieve files status for the path provided. Currently, only the total size
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
88 (in bytes) of the item is returned.
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
89 .\"------------------------------------------------------------------------
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
90 @INCLUDE:reporting-bugs@
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
91 .\"------------------------------------------------------------------------
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
92 .SH SEE ALSO
f212d5a84776 man: Add stub for doveadm-fs command
Michael Slusarz <michael.slusarz@dovecot.fi>
parents:
diff changeset
93 .BR doveadm (1)