X-Git-Url: https://git.distorted.org.uk/~mdw/disorder/blobdiff_plain/3dc3d7dbde4b666c7e829a27d5838e5ed49bdbe6..c0c23a60ef1189000787892f40f120240746e7a3:/doc/disorder-dbupgrade.8.in diff --git a/doc/disorder-dbupgrade.8.in b/doc/disorder-dbupgrade.8.in index 3d8a3b0..d7d8460 100644 --- a/doc/disorder-dbupgrade.8.in +++ b/doc/disorder-dbupgrade.8.in @@ -25,21 +25,50 @@ disorder-dbupgrade \- DisOrder Database Upgrader .RI [ PATH ...] .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. +is DisOrder's database upgrader. +It is invoked by DisOrder when 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: