- add a (simple) man page for cnid_index

diff --git a/man/man1/Makefile.am b/man/man1/Makefile.am
index 4dbf05e30cffd941fac065403f321e2a4d1a4f87..1e6013ceefeb1ea064af25a2b915201f2bf56655 100644 (file)
--- a/man/man1/Makefile.am
+++ b/man/man1/Makefile.am
@@ -35,7 +35,8 @@ NONGENERATED_MANS     =       achfile.1  \
                                timeout.1 \
                                unbin.1 \
                                unhex.1 \
-                               unsingle.1
+                               unsingle.1 \
+                               cnid_index.1
 
 man_MANS = $(GENERATED_MANS) $(NONGENERATED_MANS)
 

diff --git a/man/man1/cnid_index.1 b/man/man1/cnid_index.1
new file mode 100644 (file)
index 0000000..6787f25
--- /dev/null
+++ b/man/man1/cnid_index.1
@@ -0,0 +1,23 @@
+.TH cnid_index 1 "3 Jan 2005" 2.0.2 Netatalk 
+.SH NAME
+cnid_index \- check and repair Netatalk CNID database indexes
+.SH SYNOPSIS
+\fBcnid_index\fR \fBdbdir\fR 
+.SH DESCRIPTION
+cnid_index is a utility to check CNID databases
+for consistency. If needed, the indexes are repaired. It works for 
+databases created by the cdb and dbd backends.
+.PP
+Volumes usind the dbd CNID scheme can also be checked automatically, 
+for further information please see the \fBcnid_dbd\fR(8) man page.
+.RS 
+\fBWarning\fR
+
+When using cnid_index on cdb handled databases, 
+cnid_index cannot check if another process (afpd) accesses
+the CNID databases. In this case, you have to manually ensure no other process 
+accesses the database when running cnid_index.
+.RE
+.SH "SEE ALSO"
+\fBcnid_dbd\fR(8), \fBafpd\fR(8)
+