chiark - git - mdw - disorder/blob - doc/disorder-dump.8.in

   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 \-\-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 .PP
  81 The output file is versioned, so versions produced from a future
  82 version of DisOrder may be rejected by \fB\-\-undump\fR.
  83 It has an end marker so truncated inputs will also be rejected.
  84 .PP
  85 The input or output file must be a regular file, as it may be rewound
  86 and re-read or re-written multiple times.
  87 .PP
  88 The dump or undump operation is carried out inside a single
  89 transaction, so it should seem atomic from the point of view of
  90 anything else accessing the databases.
  91 .PP
  92 The server performs normal database recovery on startup.
  93 However if the database needs normal recovery before an undump can succeed and
  94 you don't want to start the server for some reason then the
  95 .B \-\-recover
  96 operation is available for this purpose.
  97 No other process should be accessing the database at the time.
  98 .PP
  99 DisOrder does not currently support catastrophic recovery.
 100 .PP
 101 This program requires write access to DisOrder's databases.
 102 Ideally therefore it should be run as the same user as the server or as root.
 103 .SH FILES
 104 .TP
 105 .I pkgconfdir/config
 106 Global configuration file.
 107 See \fBdisorder_config\fR(5).
 108 .SH "SEE ALSO"
 109 \fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorderd\fR(8)
 110 .\" Local Variables:
 111 .\" mode:nroff
 112 .\" End: