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