Merge disorder.macros branch.

[disorder] / doc / disorder-dump.8.in

diff --git a/doc/disorder-dump.8.in b/doc/disorder-dump.8.in
index fe7e8b40ec35a8f9d3447011a927790cd205df59..d6c6ba52f0ca8d41e129956b2b138b14311b002e 100644 (file)
--- a/doc/disorder-dump.8.in
+++ b/doc/disorder-dump.8.in
@@ -1,5 +1,5 @@
 .\"
 .\"

-.\" Copyright (C) 2004, 2005 Richard Kettlewell
+.\" Copyright (C) 2004, 2005, 2007, 2008 Richard Kettlewell

 .\"
 .\" This program is free software; you can redistribute it and/or modify
 .\" it under the terms of the GNU General Public License as published by
 .\"
 .\" This program is free software; you can redistribute it and/or modify
 .\" it under the terms of the GNU General Public License as published by


@@ -18,55 +18,57 @@
 .\"
 .TH disorder-dump 8
 .SH NAME
 .\"
 .TH disorder-dump 8
 .SH NAME

-disorder-dump \- DisOrder dump/undump tool
+disorder\-dump \- DisOrder dump/undump tool

 .SH SYNOPSIS
 .SH SYNOPSIS

-.B disorder-dump
+.B disorder\-dump

 .RI [ OPTIONS ]
 .RI [ OPTIONS ]

-.BR --dump | --undump
+.BR \-\-dump | \-\-undump

 .I PATH
 .br
 .I PATH
 .br

-.B disorder-dump
+.B disorder\-dump

 .RI [ OPTIONS ]
 .RI [ OPTIONS ]

-.BR --recompute-aliases
+.BR \-\-recompute\-aliases

 .SH DESCRIPTION
 .SH DESCRIPTION

-.B disorder-dump
+.B disorder\-dump

 is used to dump and restore preferences data.
 .SH OPTIONS
 .TP
 is used to dump and restore preferences data.
 .SH OPTIONS
 .TP

-.B --dump
-Write preferences data to \fIPATH\fR.  This can safely be used whether
-or not the server is running.
+.B \-\-dump
+Write preferences data to \fIPATH\fR.
+This can safely be used whether or not the server is running.

 .TP
 .TP

-.B --undump
+.B \-\-undump

 Read preferences data from \fIPATH\fR, replacing (unrecoverably) the
 Read preferences data from \fIPATH\fR, replacing (unrecoverably) the

-current settings.  This should normally only be done while the server
-is not running.
+current settings.
+This should normally only be done while the server is not running.

 .IP
 If the server is running then it may hang while the undump completes.
 .TP
 .IP
 If the server is running then it may hang while the undump completes.
 .TP

-.B --recover
-Perform database recovery at startup.  The server should not be
-running if this option is used.
+.B \-\-recover
+Perform database recovery at startup.
+The server should not be running if this option is used.

 .TP
 .TP

-.B --recompute-aliases
-Recompute aliases without dumping or undumping the databases.  Under
-normal circumstances this is never necessary.
+.B \-\-recompute\-aliases
+Recompute aliases without dumping or undumping the databases.
+Under normal circumstances this is never necessary.

 .TP
 .TP

-.B --remove-pathless
+.B \-\-remove\-pathless

 Remove tracks with no associated path when undumping or when
 Remove tracks with no associated path when undumping or when

-recomputing aliases.  In normal use such tracks are all aliases.
+recomputing aliases.
+In normal use such tracks are all aliases.

 .TP
 .TP

-.B --config \fIPATH\fR, \fB-c \fIPATH
-Set the configuration file.  The default is
+.B \-\-config \fIPATH\fR, \fB\-c \fIPATH
+Set the configuration file.
+The default is

 .IR /etc/disorder/config .
 .TP
 .IR /etc/disorder/config .
 .TP

-.B --debug\fR
+.B \-\-debug\fR

 Enable debugging.
 .TP
 Enable debugging.
 .TP

-.B --help\fR, \fB-h
+.B \-\-help\fR, \fB\-h

 Display a usage message.
 .TP
 Display a usage message.
 .TP

-.B --version\fR, \fB-V
+.B \-\-version\fR, \fB\-V

 Display version number.
 .SH NOTES
 This program might be used for a number of purposes:
 Display version number.
 .SH NOTES
 This program might be used for a number of purposes:


@@ -76,11 +78,11 @@ Taking a backup of the non-regeneratable parts of DisOrder's databases.
 .TP
 .B .
 Indoctrinating one DisOrder server with the preference values of
 .TP
 .B .
 Indoctrinating one DisOrder server with the preference values of

-another.  
+another.

 .PP
 The output file is versioned, so versions produced from a future
 .PP
 The output file is versioned, so versions produced from a future

-version of DisOrder may be rejected by \fB--undump\fR.  It has an end
-marker so truncated inputs will also be rejected.
+version of DisOrder may be rejected by \fB\-\-undump\fR.
+It has an end marker so truncated inputs will also be rejected.

 .PP
 The input or output file must be a regular file, as it may be rewound
 and re-read or re-written multiple times.
 .PP
 The input or output file must be a regular file, as it may be rewound
 and re-read or re-written multiple times.


@@ -89,21 +91,22 @@ The dump or undump operation is carried out inside a single
 transaction, so it should seem atomic from the point of view of
 anything else accessing the databases.
 .PP
 transaction, so it should seem atomic from the point of view of
 anything else accessing the databases.
 .PP

-The server performs normal database recovery on startup.  However if
-the database needs normal recovery before an undump can succeed and
+The server performs normal database recovery on startup.
+However if the database needs normal recovery before an undump can succeed and

 you don't want to start the server for some reason then the
 you don't want to start the server for some reason then the

-.B --recover
-operation is available for this purpose.  No other process should be
-accessing the database at the time.
+.B \-\-recover
+operation is available for this purpose.
+No other process should be accessing the database at the time.

 .PP
 DisOrder does not currently support catastrophic recovery.
 .PP
 .PP
 DisOrder does not currently support catastrophic recovery.
 .PP

-This program requires write access to DisOrder's databases.  Ideally
-therefore it should be run as the same user as the server or as root.
+This program requires write access to DisOrder's databases.
+Ideally therefore it should be run as the same user as the server or as root.

 .SH FILES
 .TP
 .I pkgconfdir/config
 .SH FILES
 .TP
 .I pkgconfdir/config

-Global configuration file.  See \fBdisorder_config\fR(5).
+Global configuration file.
+See \fBdisorder_config\fR(5).

 .SH "SEE ALSO"
 \fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorderd\fR(8)
 .\" Local Variables:
 .SH "SEE ALSO"
 \fBdisorder\fR(1), \fBdisorder_config\fR(5), \fBdisorderd\fR(8)
 .\" Local Variables: