Switch to GPL v3

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

diff --git a/doc/disorder-dbupgrade.8.in b/doc/disorder-dbupgrade.8.in
index 3d8a3b006945bc1130d8a25437ad248ae2fe458e..269822d5c91bb10ecc29175a797091c962836838 100644 (file)
--- a/doc/disorder-dbupgrade.8.in
+++ b/doc/disorder-dbupgrade.8.in
@@ -1,45 +1,72 @@
 .\"
-.\" Copyright (C) 2007 Richard Kettlewell
+.\" Copyright (C) 2007, 2008 Richard Kettlewell
 .\"
-.\" This program is free software; you can redistribute it and/or modify
+.\" This program is free software: you can redistribute it and/or modify
 .\" it under the terms of the GNU General Public License as published by
-.\" the Free Software Foundation; either version 2 of the License, or
+.\" the Free Software Foundation, either version 3 of the License, or
 .\" (at your option) any later version.
-.\"
-.\" This program is distributed in the hope that it will be useful, but
-.\" WITHOUT ANY WARRANTY; without even the implied warranty of
-.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-.\" General Public License for more details.
-.\"
+.\" 
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\" 
 .\" You should have received a copy of the GNU General Public License
-.\" along with this program; if not, write to the Free Software
-.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
-.\" USA
+.\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
 .\"
 .TH disorder-dbupgrade 8
 .SH NAME
-disorder-dbupgrade \- DisOrder Database Upgrader
+disorder\-dbupgrade \- DisOrder Database Upgrader
 .SH SYNOPSIS
-.B disorder-dbupgrade
+.B disorder\-dbupgrade
 .RI [ OPTIONS ]
 .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.
+.B disorder\-dbupgrade
+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 --config \fIPATH\fR, \fB-c \fIPATH
+.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
+.B \-\-debug\fR, \fB\-d
 Enable debugging.
 .TP
-.B --help\fR, \fB-h
+.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
+.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: