]> arthur.barton.de Git - netatalk.git/blob - man/man1/dbd.1
Add dbd manpage
[netatalk.git] / man / man1 / dbd.1
1 '\" t
2 .\"     Title: dbd
3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4 .\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
5 .\"      Date: 26 May 2009
6 .\"    Manual: Netatalk
7 .\"    Source: Netatalk
8 .\"  Language: English
9 .\"
10 .TH "DBD" "1" "26 May 2009" "2.1dev" "Netatalk"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
15 .nh
16 .\" disable justification (adjust text to left margin only)
17 .ad l
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
21 .SH "NAME"
22 dbd \- CNID database maintanance
23 .SH "SYNOPSIS"
24 .HP \w'\fBdbd\fR\fB\fR\ 'u
25 \fBdbd\fR\fB\fR [\-evx] \-d\ [\-i]  | \-s | \-r\ [\-f]   \fIvolumepath\fR
26 .SH "DESCRIPTION"
27 .PP
28 \fBdbd\fR
29 can dump, scan, reindex and rebuild
30 \fINetatalk\fR
31 dbd CNID databases\&. It must be run with appropiate permissions i\&.e\&. as root\&.
32 .SH "COMMANDS"
33 .PP
34 \-d
35 .RS 4
36 Dump CNID database\&. With
37 \fB\-i \fRdump indexes too\&.
38 .RE
39 .PP
40 \-s
41 .RS 4
42 Scan volume:
43 .sp
44 .RS 4
45 .ie n \{\
46 \h'-04'\(bu\h'+03'\c
47 .\}
48 .el \{\
49 .sp -1
50 .IP \(bu 2.3
51 .\}
52 Compare CNIDs in database with volume
53 .RE
54 .sp
55 .RS 4
56 .ie n \{\
57 \h'-04'\(bu\h'+03'\c
58 .\}
59 .el \{\
60 .sp -1
61 .IP \(bu 2.3
62 .\}
63 Test if AppleDouble directories exist
64 .RE
65 .sp
66 .RS 4
67 .ie n \{\
68 \h'-04'\(bu\h'+03'\c
69 .\}
70 .el \{\
71 .sp -1
72 .IP \(bu 2.3
73 .\}
74 Test if AppleDouble files exist
75 .RE
76 .sp
77 .RS 4
78 .ie n \{\
79 \h'-04'\(bu\h'+03'\c
80 .\}
81 .el \{\
82 .sp -1
83 .IP \(bu 2.3
84 .\}
85 Report orphaned AppleDouble files
86 .RE
87 .sp
88 .RS 4
89 .ie n \{\
90 \h'-04'\(bu\h'+03'\c
91 .\}
92 .el \{\
93 .sp -1
94 .IP \(bu 2.3
95 .\}
96 Report directories inside AppleDouble directories
97 .RE
98 .sp
99 .RS 4
100 .ie n \{\
101 \h'-04'\(bu\h'+03'\c
102 .\}
103 .el \{\
104 .sp -1
105 .IP \(bu 2.3
106 .\}
107 Check name encoding by roundtripping, log on error
108 .RE
109 .sp
110 .RS 4
111 .ie n \{\
112 \h'-04'\(bu\h'+03'\c
113 .\}
114 .el \{\
115 .sp -1
116 .IP \(bu 2.3
117 .\}
118 Check for orphaned CNIDs in database (requires
119 \fB\-e\fR)
120 .RE
121 .RE
122 .PP
123 \-r
124 .RS 4
125 Rebuild volume\&. With
126 \fB\-f\fR
127 wipe database and rebuild from CNIIDs stored in AppleDouble files, only available for volumes with \'cachecnid\' option\&. Implies
128 \fB\-e\fR\&.
129 .sp
130 .RS 4
131 .ie n \{\
132 \h'-04'\(bu\h'+03'\c
133 .\}
134 .el \{\
135 .sp -1
136 .IP \(bu 2.3
137 .\}
138 Sync CNIDSs from database with volume
139 .RE
140 .sp
141 .RS 4
142 .ie n \{\
143 \h'-04'\(bu\h'+03'\c
144 .\}
145 .el \{\
146 .sp -1
147 .IP \(bu 2.3
148 .\}
149 Ensure AppleDouble directories exist
150 .RE
151 .sp
152 .RS 4
153 .ie n \{\
154 \h'-04'\(bu\h'+03'\c
155 .\}
156 .el \{\
157 .sp -1
158 .IP \(bu 2.3
159 .\}
160 Ensure AppleDouble files exist
161 .RE
162 .sp
163 .RS 4
164 .ie n \{\
165 \h'-04'\(bu\h'+03'\c
166 .\}
167 .el \{\
168 .sp -1
169 .IP \(bu 2.3
170 .\}
171 Delete orphaned AppleDouble files
172 .RE
173 .sp
174 .RS 4
175 .ie n \{\
176 \h'-04'\(bu\h'+03'\c
177 .\}
178 .el \{\
179 .sp -1
180 .IP \(bu 2.3
181 .\}
182 Report directories inside AppleDouble directories
183 .RE
184 .sp
185 .RS 4
186 .ie n \{\
187 \h'-04'\(bu\h'+03'\c
188 .\}
189 .el \{\
190 .sp -1
191 .IP \(bu 2.3
192 .\}
193 Check name encoding by roundtripping, log on error
194 .RE
195 .sp
196 .RS 4
197 .ie n \{\
198 \h'-04'\(bu\h'+03'\c
199 .\}
200 .el \{\
201 .sp -1
202 .IP \(bu 2.3
203 .\}
204 Delete orphaned CNIDs in database (requires
205 \fB\-e\fR)
206 .RE
207 .RE
208 .SH "OPTIONS"
209 .PP
210 \-e
211 .RS 4
212 Only work on inactive volumes and lock them (exclusive)
213 .RE
214 .PP
215 \-x
216 .RS 4
217 Rebuild indexes (just for completeness, mostly useless!)
218 .RE
219 .PP
220 \-v
221 .RS 4
222 verbose
223 .RE
224 .SH "WARNING"
225 .PP
226 If you want/need to run an \-r \-f rebuild after adding \'cachecnid\' to a volume configuration, you must run a rebuild with \-r alone at first in order to sync all existing CNIDs from the db to the AppleDouble files!
227 .SH "CNID BACKGROUND"
228 .PP
229 The CNID backends maintains name to ID mappings\&. If you change a filename outside afpd(8) (shell, samba), the CNID db will not know and doesn\'t reflect that change\&. Netatalk tries to recover from such inconsistencies as gracefully as possible\&. The mechanisms to resolve such inconsistencies may fail sometimes, though, as this is not an easy task to accomplish\&. E\&.g\&. if several names in the path to the file or directory have changed, things may go wrong\&.
230 .PP
231 If you change a lot of filenames at once, chances are higher that the afpds fallback mechanisms fail, i\&.e\&. files will be assigned new IDs, even though the file hasn\'t changed\&.
232 .SH "SEE ALSO"
233 .PP
234 \fBcnid_metad\fR(8),
235 \fBcnid_dbd\fR(8)