'\" t
.\" Title: dbd
.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
-.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
-.\" Date: 26 May 2009
-.\" Manual: Netatalk
-.\" Source: Netatalk
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\" Date: 14 Sep 2012
+.\" Manual: Netatalk 3.0
+.\" Source: Netatalk 3.0
.\" Language: English
.\"
-.TH "DBD" "1" "26 May 2009" "2.1dev" "Netatalk"
+.TH "DBD" "1" "14 Sep 2012" "Netatalk 3.0" "Netatalk 3.0"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
-dbd \- CNID database maintanance
+dbd \- CNID database maintenance
.SH "SYNOPSIS"
.HP \w'\fBdbd\fR\fB\fR\ 'u
-\fBdbd\fR\fB\fR [\-evx] \-d\ [\-i] | \-s | \-r\ [\-f] \fIvolumepath\fR
+\fBdbd\fR\fB\fR [\-evx] {\-d\ [\-i] | \-s\ [\-c|\-n] | \-r\ [\-c|\-f|\-C] | \-u} \fIvolumepath\fR
.SH "DESCRIPTION"
.PP
\fBdbd\fR
can dump, scan, reindex and rebuild
\fINetatalk\fR
dbd CNID databases\&. It must be run with appropiate permissions i\&.e\&. as root\&.
+\fBdbd\fR
+\fB\-s|\-r\fR
+can be run on active volumes, but
+\fBdbd \-rf\fR, which wipes the db before rebuilding it, checks and enforces that the chosen volume is not in use\&.
.SH "COMMANDS"
.PP
\-d
.RS 4
Scan volume:
.sp
+Compare CNIDs in database with volume, test if \&.AppleDouble directories exist, test if AppleDouble files exist, report orphaned AppleDouble files, report directories inside \&.AppleDouble directories, check name encoding, heck for orphaned CNIDs in database (requires
+\fB\-e\fR)\&.
+Options:
+.PP
+\-c
.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Compare CNIDs in database with volume
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Test if AppleDouble directories exist
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Test if AppleDouble files exist
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Report orphaned AppleDouble files
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Report directories inside AppleDouble directories
-.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Check name encoding by roundtripping, log on error
+Don\'t check \&.AppleDouble stuff, only check orphaned\&.
.RE
-.sp
+.PP
+\-n
.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Check for orphaned CNIDs in database (requires
-\fB\-e\fR)
+Don\'t open CNID database, skip CNID checks, only traverse filesystem
.RE
.RE
.PP
\-r
.RS 4
-Rebuild volume\&. With
-\fB\-f\fR
-wipe database and rebuild from CNIIDs stored in AppleDouble files, only available for volumes with \'cachecnid\' option\&. Implies
-\fB\-e\fR\&.
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Sync CNIDSs from database with volume
-.RE
+Rebuild volume:
.sp
+Sync CNIDSs from database with volume, ensure \&.AppleDouble directories exist, ensure AppleDouble files exist, delete orphaned AppleDouble files, report directories inside \&.AppleDouble directories, check name encoding by roundtripping, delete orphaned CNIDs in database (requires
+\fB\-e\fR)\&.
+Options:
+.PP
+\-C
.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Ensure AppleDouble directories exist
+Converts volume from adouble:v2 to adouble:ea
.RE
-.sp
+.PP
+\-c
.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Ensure AppleDouble files exist
+Don\'t create \&.AppleDouble stuff, only cleanup orphaned\&.
.RE
-.sp
+.PP
+\-f
.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Delete orphaned AppleDouble files
+Wipe database and rebuild from IDs stored in AppleDouble files, only available for volumes without
+\fBnocnidcache\fR
+option\&. Implies
+\fB\-e\fR\&.
.RE
-.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Report directories inside AppleDouble directories
.RE
-.sp
+.PP
+\-u
.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Check name encoding by roundtripping, log on error
-.RE
+Upgrade:
.sp
-.RS 4
-.ie n \{\
-\h'-04'\(bu\h'+03'\c
-.\}
-.el \{\
-.sp -1
-.IP \(bu 2.3
-.\}
-Delete orphaned CNIDs in database (requires
-\fB\-e\fR)
-.RE
+Opens the database which triggers any necessary upgrades, then closes and exits\&.
.RE
.SH "OPTIONS"
.PP
.RE
.SH "WARNING"
.PP
-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!
+In order to be able to run
+\fB\-rf\fR
+reconstructing the CNIDs in the database from the
+\fIAppleDouble\fR
+files, make sure you\'ve run a
+\fB\-r\fR
+rebuild sometimes before, where the CNIDs then would have been synched between database and
+\fIAppleDouble\fR
+files\&.
+.PP
+Also be careful about the option
+\fBnocnidcache\fR\&. Avoid this option if at all possible, because if prevents you from being able to use
+\fB\-f\fR\&.
.SH "CNID BACKGROUND"
.PP
-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\&.
+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 not 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\&.
.PP
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\&.
.SH "SEE ALSO"
projects / netatalk.git / blobdiff