| 1 | .\" |
| 2 | .\" Copyright (C) 2004, 2005, 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-dump 8 |
| 18 | .SH NAME |
| 19 | disorder\-dump \- DisOrder dump/undump tool |
| 20 | .SH SYNOPSIS |
| 21 | .B disorder\-dump |
| 22 | .RI [ OPTIONS ] |
| 23 | .BR \-\-dump | \-\-undump |
| 24 | .I PATH |
| 25 | .br |
| 26 | .B disorder\-dump |
| 27 | .RI [ OPTIONS ] |
| 28 | .BR \-\-recompute\-aliases |
| 29 | .SH DESCRIPTION |
| 30 | .B disorder\-dump |
| 31 | is used to dump and restore preferences data. |
| 32 | .SH OPTIONS |
| 33 | .TP |
| 34 | .B \-\-dump |
| 35 | Write preferences data to \fIPATH\fR. |
| 36 | This can safely be used whether or not the server is running. |
| 37 | .TP |
| 38 | .B \-\-undump |
| 39 | Read preferences data from \fIPATH\fR, replacing (unrecoverably) the |
| 40 | current settings. |
| 41 | This should normally only be done while the server is not running. |
| 42 | .IP |
| 43 | If the server is running then it may hang while the undump completes. |
| 44 | .TP |
| 45 | .B \-\-recover |
| 46 | Perform database recovery at startup. |
| 47 | The server should not be running if this option is used. |
| 48 | .TP |
| 49 | .B \-\-recompute\-aliases |
| 50 | Recompute aliases without dumping or undumping the databases. |
| 51 | Under normal circumstances this is never necessary. |
| 52 | .TP |
| 53 | .B \-\-remove\-pathless |
| 54 | Remove tracks with no associated path when undumping or when |
| 55 | recomputing aliases. |
| 56 | In normal use such tracks are all aliases. |
| 57 | .TP |
| 58 | .B \-\-config \fIPATH\fR, \fB\-c \fIPATH |
| 59 | Set the configuration file. |
| 60 | The default is |
| 61 | .IR /etc/disorder/config . |
| 62 | .TP |
| 63 | .B \-\-no\-setuid |
| 64 | Do not change UID. |
| 65 | .TP |
| 66 | .B \-\-debug\fR |
| 67 | Enable debugging. |
| 68 | .TP |
| 69 | .B \-\-help\fR, \fB\-h |
| 70 | Display a usage message. |
| 71 | .TP |
| 72 | .B \-\-version\fR, \fB\-V |
| 73 | Display version number. |
| 74 | .SH NOTES |
| 75 | This program might be used for a number of purposes: |
| 76 | .TP 2 |
| 77 | .B . |
| 78 | Taking a backup of the non-regeneratable parts of DisOrder's databases. |
| 79 | .TP |
| 80 | .B . |
| 81 | Indoctrinating one DisOrder server with the preference values of |
| 82 | another. |
| 83 | .PP |
| 84 | The output file is versioned, so versions produced from a future |
| 85 | version of DisOrder may be rejected by \fB\-\-undump\fR. |
| 86 | It has an end marker so truncated inputs will also be rejected. |
| 87 | .PP |
| 88 | The input or output file must be a regular file, as it may be rewound |
| 89 | and re-read or re-written multiple times. |
| 90 | .PP |
| 91 | The dump or undump operation is carried out inside a single |
| 92 | transaction, so it should seem atomic from the point of view of |
| 93 | anything else accessing the databases. |
| 94 | .PP |
| 95 | The server performs normal database recovery on startup. |
| 96 | However if the database needs normal recovery before an undump can succeed and |
| 97 | you don't want to start the server for some reason then the |
| 98 | .B \-\-recover |
| 99 | operation is available for this purpose. |
| 100 | No other process should be accessing the database at the time. |
| 101 | .PP |
| 102 | DisOrder does not currently support catastrophic recovery. |
| 103 | .PP |
| 104 | This program requires write access to DisOrder's databases. |
| 105 | Therefore it should be run as the same user as the server or as root. |
| 106 | .PP |
| 107 | If a restore is done as root then it will automatically change to the |
| 108 | server user, so that the new files end up with the right ownership. |
| 109 | This can be suppressed with the \fB\-\-no\-setuid\fR option. |
| 110 | .SH FILES |
| 111 | .TP |
| 112 | .I pkgconfdir/config |
| 113 | Global configuration file. |
| 114 | See \fBdisorder_config\fR(5). |
| 115 | .SH "SEE ALSO" |
| 116 | \fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorderd\fR(8) |
| 117 | .\" Local Variables: |
| 118 | .\" mode:nroff |
| 119 | .\" End: |