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