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