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 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.
  38 This can safely be used whether or not the server is running.
  39 .TP
  40 .B \-\-undump
  41 Read preferences data from \fIPATH\fR, replacing (unrecoverably) the
  42 current settings.
  43 This should normally only be done while the server 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.
  49 The server should not be running if this option is used.
  50 .TP
  51 .B \-\-recompute\-aliases
  52 Recompute aliases without dumping or undumping the databases.
  53 Under 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.
  58 In normal use such tracks are all aliases.
  59 .TP
  60 .B \-\-config \fIPATH\fR, \fB\-c \fIPATH
  61 Set the configuration file.
  62 The default is
  63 .IR /etc/disorder/config .
  64 .TP
  65 .B \-\-debug\fR
  66 Enable debugging.
  67 .TP
  68 .B \-\-help\fR, \fB\-h
  69 Display a usage message.
  70 .TP
  71 .B \-\-version\fR, \fB\-V
  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
  81 another.
  82 .PP
  83 The output file is versioned, so versions produced from a future
  84 version of DisOrder may be rejected by \fB\-\-undump\fR.
  85 It has an end marker so truncated inputs will also be rejected.
  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
  94 The server performs normal database recovery on startup.
  95 However if the database needs normal recovery before an undump can succeed and
  96 you don't want to start the server for some reason then the
  97 .B \-\-recover
  98 operation is available for this purpose.
  99 No other process should be accessing the database at the time.
 100 .PP
 101 DisOrder does not currently support catastrophic recovery.
 102 .PP
 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.
 105 .SH FILES
 106 .TP
 107 .I pkgconfdir/config
 108 Global configuration file.
 109 See \fBdisorder_config\fR(5).
 110 .SH "SEE ALSO"
 111 \fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorderd\fR(8)
 112 .\" Local Variables:
 113 .\" mode:nroff
 114 .\" End: