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

   1 .\"
   2 .\" Copyright (C) 2007, 2008 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.
  29 It is invoked by DisOrder when necessary and does not normally need to
  30 be invoked manually.
  31 .SH OPTIONS
  32 .TP
  33 .B \-\-delete\-bad\-keys\fR, \-x
  34 If invalid keys are found in the database then delete them.
  35 See
  36 .B "INVALID KEYS"
  37 below.
  38 .TP
  39 .B \-\-fail\-bad\-keys\fR, \-X
  40 If invalid keys are found in the database then fail.
  41 See
  42 .B "INVALID KEYS"
  43 below.
  44 .TP
  45 .B \-\-config \fIPATH\fR, \fB\-c \fIPATH
  46 Set the configuration file.
  47 .TP
  48 .B \-\-debug\fR, \fB\-d
  49 Enable debugging.
  50 .TP
  51 .B \-\-syslog
  52 Log to syslog.
  53 This is the default if stderr is not a terminal.
  54 .TP
  55 .B \-\-no\-syslog
  56 Do not log to syslog.
  57 This is the default if stderr is a terminal.
  58 .TP
  59 .B \-\-help\fR, \fB\-h
  60 Display a usage message.
  61 .TP
  62 .B \-\-version\fR, \fB\-V
  63 Display version number.
  64 .SH "INVALID KEYS"
  65 An invalid key is one that is not valid UTF-8 or cannot be converted
  66 to NFC for some reason.
  67 By default a warning message is issued and they are left in the
  68 database (if doing so will not compromise its integrity).
  69 The
  70 .B \-x
  71 option can be used to delete them if they are known to be harmless.
  72 .SH "SEE ALSO"
  73 \fBdisorderd\fR(8), \fBdisorder_config\fR(5)
  74 .\" Local Variables:
  75 .\" mode:nroff
  76 .\" End: