man-page-misc-improvements-20051221
[openafs.git] / doc / man-pages / pod8 / voldump.pod
1 =head1 NAME
2
3 voldump - Dump an AFS volume without using the Volume Server
4
5 =head1 SYNOPSIS
6
7 B<voldump> B<-part> <I<partition>> B<-volumeid> <I<volume id>>
8     [B<-file> <I<dump file>>] [B<-verbose>] [B<-help>]
9
10 B<voldump> B<-p> <I<partition>> B<-vo> <I<volume id>>
11     [B<-f> <I<dump file>>] [B<-ve>] [B<-h>]
12
13 =head1 DESCRIPTION
14
15 B<voldump> dumps an AFS volume in the format used by B<vos dump> without
16 using the Volume Server.  It must be run on the file server machine and
17 usually must be run as the superuser C<root> to have permissions to read
18 the file server data.  It's primary use is to recover data from a file
19 server machine where the Volume Server cannot be started for some reason.
20
21 The dump output will go to standard output, or to a file if B<-file> is
22 specified.  B<vos restore> can be used to load the resulting dump into a
23 new AFS volume.  B<voldump> always does a full dump.
24
25 =head1 CAUTIONS
26
27 Normally, use B<vos dump> instead of this command.  B<voldump> is a tool
28 of last resort to try to extract data from the raw data structures stored
29 on the file server machine and is not as regularly tested or used as the
30 normal B<vos dump> implementation.
31
32 If the AFS volume being dumped changes while B<voldump> is running, the
33 results may be inconsistent.  If the File Server and Volume Server are
34 running, stop them with B<bos shutdown> or a similar method before running
35 this command.
36
37 =head1 OPTIONS
38
39 =over 4
40
41 =item B<-part> <I<partition>>
42
43 Names the partition on which the volume to be dumped is located.
44 B<voldump> does not take the normal full range of ways of specifying a
45 partition.  Instead, I<partition> must be either a single letter between
46 C<a> and C<z>, corresponding to F</vicepa> through F</vicepz>, or the full
47 path to the file server partition.  C<aa> is not recognized; use
48 F</vicepaa> instead.
49
50 =item B<-volumeid> <I<volume id>>
51
52 Specifies the ID of the volume to dump.  The volume must be specified by
53 numeric ID, not by name.
54
55 =item B<-file> <I<dump file>>
56
57 Specifies the output file for the dump.  If this option is not given, the
58 volume will be dumped to standard output.
59
60 =item B<-verbose>
61
62 Asks for a verbose trace of the dump process.  This trace information will
63 be sent to standard error.
64
65 =back
66
67 =head1 EXAMPLES
68
69 The following command dumps the volume 1936964939 on the F</vicepb>
70 partition to the file F</tmp/volume.dump>:
71
72     % voldump -part /vicepb -volumeid 1936964939 -file /tmp/volume.dump
73
74 =head1 PRIVILEGE REQUIRED
75
76 The issuer must have read access to the file server data stored in the
77 specified partition.  Usually, this means that the issuer must be the
78 local superuser C<root> on the file server machine.
79
80 =head1 SEE ALSO
81
82 L<bos_shutdown(8)>,
83 L<volserver(8)>,
84 L<vos_dump(1)>,
85 L<vos_restore(1)>
86
87 =head1 COPYRIGHT
88
89 Copyright 2005 Russ Allbery <rra@stanford.edu>
90
91 This documentation is covered by the IBM Public License Version 1.0.  This
92 man page was written by Russ Allbery for OpenAFS.