| 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 3 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, |
| 10 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | .\" GNU 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, see <http://www.gnu.org/licenses/>. |
| 16 | .\" |
| 17 | .TH disorder-dbupgrade 8 |
| 18 | .SH NAME |
| 19 | disorder\-dbupgrade \- DisOrder Database Upgrader |
| 20 | .SH SYNOPSIS |
| 21 | .B disorder\-dbupgrade |
| 22 | .RI [ OPTIONS ] |
| 23 | .RI [ PATH ...] |
| 24 | .SH DESCRIPTION |
| 25 | .B disorder\-dbupgrade |
| 26 | is DisOrder's database upgrader. |
| 27 | It is invoked by DisOrder when necessary and does not normally need to |
| 28 | be invoked manually. |
| 29 | .SH OPTIONS |
| 30 | .TP |
| 31 | .B \-\-delete\-bad\-keys\fR, \-x |
| 32 | If invalid keys are found in the database then delete them. |
| 33 | 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. |
| 39 | See |
| 40 | .B "INVALID KEYS" |
| 41 | below. |
| 42 | .TP |
| 43 | .B \-\-config \fIPATH\fR, \fB\-c \fIPATH |
| 44 | Set the configuration file. |
| 45 | .TP |
| 46 | .B \-\-debug\fR, \fB\-d |
| 47 | Enable debugging. |
| 48 | .TP |
| 49 | .B \-\-syslog |
| 50 | Log to syslog. |
| 51 | This is the default if stderr is not a terminal. |
| 52 | .TP |
| 53 | .B \-\-no\-syslog |
| 54 | Do not log to syslog. |
| 55 | This is the default if stderr is a terminal. |
| 56 | .TP |
| 57 | .B \-\-help\fR, \fB\-h |
| 58 | Display a usage message. |
| 59 | .TP |
| 60 | .B \-\-version\fR, \fB\-V |
| 61 | Display version number. |
| 62 | .SH "INVALID KEYS" |
| 63 | An invalid key is one that is not valid UTF-8 or cannot be converted |
| 64 | to NFC for some reason. |
| 65 | By default a warning message is issued and they are left in the |
| 66 | database (if doing so will not compromise its integrity). |
| 67 | The |
| 68 | .B \-x |
| 69 | option can be used to delete them if they are known to be harmless. |
| 70 | .SH "SEE ALSO" |
| 71 | \fBdisorderd\fR(8), \fBdisorder_config\fR(5) |
| 72 | .\" Local Variables: |
| 73 | .\" mode:nroff |
| 74 | .\" End: |