chiark - git - mdw - disorder/blob - doc/disorder-dbupgrade.8.in

   1 .\"
   2 .\" Copyright (C) 2007 Richard Kettlewell
   3 .\"
   4 .\" This program is free software; you can redistribute it and/or modify
   5 .\" it under the terms of the GNU General Public License as published by
   6 .\" the Free Software Foundation; either version 2 of the License, or
   7 .\" (at your option) any later version.
   8 .\"
   9 .\" This program is distributed in the hope that it will be useful, but
  10 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
  11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12 .\" General Public License for more details.
  13 .\"
  14 .\" You should have received a copy of the GNU General Public License
  15 .\" along with this program; if not, write to the Free Software
  16 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  17 .\" USA
  18 .\"
  19 .TH disorder-dbupgrade 8
  20 .SH NAME
  21 disorder-dbupgrade \- DisOrder Database Upgrader
  22 .SH SYNOPSIS
  23 .B disorder-dbupgrade
  24 .RI [ OPTIONS ]
  25 .RI [ PATH ...]
  26 .SH DESCRIPTION
  27 .B disorder-dbupgrade
  28 is DisOrder's database upgrader.  It is invoked by DisOrder when
  29 necessary and does not normally need to be invoked manually.
  30 .SH OPTIONS
  31 .TP
  32 .B --delete-bad-keys\fR, -x
  33 If invalid keys are found in the database then delete them.  See
  34 .B "INVALID KEYS"
  35 below.
  36 .TP
  37 .B --fail-bad-keys\fR, -X
  38 If invalid keys are found in the database then fail.  See
  39 .B "INVALID KEYS"
  40 below.
  41 .TP
  42 .B --config \fIPATH\fR, \fB-c \fIPATH
  43 Set the configuration file.
  44 .TP
  45 .B --debug\fR, \fB-d
  46 Enable debugging.
  47 .TP
  48 .B --syslog
  49 Log to syslog.  This is the default if stderr is not a terminal.
  50 .TP
  51 .B --no-syslog
  52 Do not log to syslog.  This is the default if stderr is a terminal.
  53 .TP
  54 .B --help\fR, \fB-h
  55 Display a usage message.
  56 .TP
  57 .B --version\fR, \fB-V
  58 Display version number.
  59 .SH "INVALID KEYS"
  60 An invalid key is one that is not valid UTF-8 or cannot be converted
  61 to NFC for some reason.  By default a warning message is issued and
  62 they are left in the database (if doing so will not compromise its
  63 integrity).  The
  64 .B -x
  65 option can be used to delete them if they are known to be harmless.
  66 .SH "SEE ALSO"
  67 \fBdisorderd\fR(8), \fBdisorder_config\fR(5)
  68 .\" Local Variables:
  69 .\" mode:nroff
  70 .\" End: