Fixes for disorder-dbpugrade:

[disorder] / doc / disorder-dbupgrade.8.in

diff --git a/doc/disorder-dbupgrade.8.in b/doc/disorder-dbupgrade.8.in
index 3d8a3b0..7da152b 100644 (file)
--- a/doc/disorder-dbupgrade.8.in
+++ b/doc/disorder-dbupgrade.8.in
@@ -29,6 +29,16 @@ is DisOrder's database upgrader.  It is invoked by DisOrder when
 necessary and does not need to be invoked manually.
 .SH OPTIONS
 .TP
 necessary and does not need to be invoked manually.
 .SH OPTIONS
 .TP

+.B --delete-bad-keys\fR, -x
+If invalid keys are found in the database then delete them.  See
+.B "INVALID KEYS"
+below.
+.TP
+.B --fail-bad-keys\fR, -X
+If invalid keys are found in the database then fail.  See
+.B "INVALID KEYS"
+below.
+.TP

 .B --config \fIPATH\fR, \fB-c \fIPATH
 Set the configuration file.
 .TP
 .B --config \fIPATH\fR, \fB-c \fIPATH
 Set the configuration file.
 .TP


@@ -40,6 +50,13 @@ Display a usage message.
 .TP
 .B --version\fR, \fB-V
 Display version number.
 .TP
 .B --version\fR, \fB-V
 Display version number.

+.SH "INVALID KEYS"
+An invalid key is one that is not valid UTF-8 or cannot be converted
+to NFC for some reason.  By default a warning message is issued and
+they are left in the database (if doing so will not compromise its
+integrity).  The
+.B -x
+option can be used to delete them if they are known to be harmles.

 .SH "SEE ALSO"
 \fBdisorderd\fR(8), \fBdisorder_config\fR(5)
 .\" Local Variables:
 .SH "SEE ALSO"
 \fBdisorderd\fR(8), \fBdisorder_config\fR(5)
 .\" Local Variables: