man-page-whitespace-20051220
[openafs.git] / doc / man-pages / pod8 / backup_volinfo.pod
1 =head1 NAME
2
3 backup volinfo - Displays a volume's dump history from the Backup Database
4
5 =head1 SYNOPSIS
6
7 B<backup volinfo> B<-volume> <I<volume name>> [B<-localauth>]
8     [B<-cell> <I<cell name>>] [B<-help>]
9
10 B<backup voli> B<-v> <I<volume name>> [B<-l>] [B<-c> <I<cell name>>] [B<-h>]
11
12 =head1 DESCRIPTION
13
14 The B<backup volinfo> command displays a dump history of the specified
15 volume, reporting information such as the date on which the volume was
16 dumped and the tapes that contain it. Include the C<.backup> extension on
17 the volume name if the backup version of the volume was dumped.
18
19 =head1 OPTIONS
20
21 =over 4
22
23 =item B<-volume> <I<volume name>>
24
25 Names the volume for which to display the dump history. Include the
26 C<.backup> or C<.readonly> extension if the backup or read-only version of
27 the volume was dumped.
28
29 =item B<-localauth>
30
31 Constructs a server ticket using a key from the local
32 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
33 it to the Backup Server, Volume Server and VL Server during mutual
34 authentication. Do not combine this flag with the B<-cell> argument. For
35 more details, see L<backup(8)>.
36
37 =item B<-cell> <I<cell name>>
38
39 Names the cell in which to run the command. Do not combine this argument
40 with the B<-localauth> flag. For more details, see L<backup(8)>.
41
42 =item B<-help>
43
44 Prints the online help for this command. All other valid options are
45 ignored.
46
47 =back
48
49 =head1 OUTPUT
50
51 The output includes a line for each Backup Database dump record that
52 mentions the specified volume, order from most to least recent. The output
53 for each record appears in a table with six columns:
54
55 =over 4
56
57 =item dumpID
58
59 The dump ID of the dump that includes the volume.
60
61 =item lvl
62
63 The depth in the dump hierarchy of the dump level at which the volume was
64 dumped. A value of C<0> indicates a full dump. A value of C<1> or greater
65 indicates an incremental dump made at the specified depth in the dump
66 hierarchy.
67
68 =item parentid
69
70 The dump ID of the dump's parent dump. A value of C<0> indicates a full
71 dump, which has no parent; in this case, the value in the C<lvl> column is
72 also C<0>.
73
74 =item creation date
75
76 The date and time at which the Backup System started the dump operation
77 that created the dump.
78
79 =item clone date
80
81 For a backup or read-only volume, the time at which it was cloned from its
82 read/write source. For a read/write volume, the same as the value in the
83 C<creation date> field.
84
85 =item tape name
86
87 The name of the tape containing the dump: either the permanent tape name,
88 or an AFS tape name in the format
89 I<volume_set_name>.I<dump_level_name>.I<tape_index> where
90 I<volume_set_name> is the name of the volume set associated with the
91 initial dump in the dump set of which this tape is a part;
92 I<dump_level_name> is the name of the dump level at which the initial dump
93 was backed up; I<tape_index> is the ordinal of the tape in the dump
94 set. Either type of name can be followed by a dump ID in parentheses; if
95 it appears, it is the dump ID of the initial dump in the dump set to which
96 this appended dump belongs.
97
98 =back
99
100 =head1 EXAMPLES
101
102 The following example shows part of the dump history of the Backup volume
103 C<user.smith.backup>:
104
105    % backup volinfo -volume user.smith.backup
106    DumpID    lvl parentID  creation date    clone date       tape name
107    924600000 1   924427600 04/20/1999 05:20 04/20/1999 05:01 user_incr_2 (924514392)
108    924514392 1   924427600 04/19/1999 05:33 04/19/1999 05:08 user_incr_2
109    924427600 0           0 04/18/1999 05:26 04/18/1999 04:58 user_full_6
110        .     .      .         .       .       .      .         .
111        .     .      .         .       .       .      .         .
112
113 =head1 PRIVILEGE REQUIRED
114
115 None
116
117 =head1 SEE ALSO
118
119 L<backup(8)>,
120 L<backup_dumpinfo(8)>,
121 L<backup_volrestore(8)>
122
123 =head1 COPYRIGHT
124
125 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
126
127 This documentation is covered by the IBM Public License Version 1.0.  It was
128 converted from HTML to POD by software written by Chas Williams and Russ
129 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.