X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/4ecbdbd99dea3236c3c6d5ea5401a08c56de5d3c..4a4c673c7705370b080f225d959293b845168a0c:/doc/disorder-dbupgrade.8.in

diff --git a/doc/disorder-dbupgrade.8.in b/doc/disorder-dbupgrade.8.in
index 3d8a3b0..3a6c2d7 100644
--- a/doc/disorder-dbupgrade.8.in
+++ b/doc/disorder-dbupgrade.8.in
@@ -26,20 +26,43 @@ disorder-dbupgrade \- DisOrder Database Upgrader
 .SH DESCRIPTION
 .B disorder-dbupgrade
 is DisOrder's database upgrader.  It is invoked by DisOrder when
-necessary and does not need to be invoked manually.
+necessary and does not normally 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 --debug\fR, \fB-d
 Enable debugging.
 .TP
+.B --syslog
+Log to syslog.  This is the default if stderr is not a terminal.
+.TP
+.B --no-syslog
+Do not log to syslog.  This is the default if stderr is a terminal.
+.TP
 .B --help\fR, \fB-h
 Display a usage message.
 .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 harmless.
 .SH "SEE ALSO"
 \fBdisorderd\fR(8), \fBdisorder_config\fR(5)
 .\" Local Variables: