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