man8-editing-pass-20051213
[openafs.git] / doc / man-pages / pod8 / backup_listdumps.pod
1 =head1 NAME
2
3 backup listdumps - Displays the dump hierarchy from the Backup Database
4
5 =head1 SYNOPSIS
6
7 B<backup listdumps> [B<-localauth>] [B<-cell> <I<cell name>>] [B<-help>]
8
9 B<backup listd> [B<-l>] [B<-c> <I<cell name>>] [B<-h>]
10
11 =head1 DESCRIPTION
12
13 The B<backup listdumps> command displays the dump hierarchy from the
14 Backup Database.
15
16 =head1 OPTIONS
17
18 =over 4
19
20 =item B<-localauth>
21
22 Constructs a server ticket using a key from the local
23 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
24 it to the Backup Server, Volume Server and VL Server during mutual
25 authentication. Do not combine this flag with the B<-cell> argument. For
26 more details, see L<backup(8)>.
27
28 =item B<-cell> <I<cell name>>
29
30 Names the cell in which to run the command. Do not combine this argument
31 with the B<-localauth> flag. For more details, see L<backup(8)>.
32
33 =item B<-help>
34
35 Prints the online help for this command. All other valid options are
36 ignored.
37
38 =back
39
40 =head1 OUTPUT
41
42 The output displays the complete dump hierarchy and indicates the
43 relationship between full and incremental dump levels. Full dump levels
44 appear at the left margin. The hierarchy can include more than one full
45 dump level; each one defines a subhierarchy of dump levels that can be
46 used for dumping different volume sets.
47
48 Incremental dump levels appear below and indented to the right of their
49 parent dump levels, which can be either full or incremental. Since
50 multiple incremental dump levels can share the same parent, an incremental
51 dump level is not always directly below its parent; the amount of
52 indentation indicates the parent/child relationship.
53
54 If a dump level has an associated expiration date, it appears along with
55 the level name. Absolute expiration dates appear in the format
56
57    <dump_level> expires at <day month date time year>    
58
59 and relative expiration dates in the format
60
61    <dump_level> expires in {<years>y | <months>m | <days>d}
62
63 to indicate the number of years, months, days, or combination of the three
64 after creation a dump expires when created at this level.
65
66 =head1 EXAMPLES
67
68 The following example depicts six dump hierarchies. The expiration date
69 for all incremental dump levels is 13 days so that the corresponding tapes
70 can be recycled two weeks after their creation. The expiration dates for
71 all full dump levels is 27 days so that the corresponding tapes can be
72 recycled four weeks after their creation.
73
74    % backup listdumps
75    /week1  expires in  27d
76          /tuesday  expires in  13d
77                  /thursday  expires in  13d
78          /sunday  expires in  13d
79                 /tuesday expires in  13d
80                         /thursday expires in  13d
81    /week3  expires in  27d
82          /tuesday  expires in  13d
83                  /thursday  expires in  13d
84          /sunday  expires in  13d
85                 /tuesday  expires in  13d
86                         /thursday  expires in  13d
87    /sunday1  expires in  27d
88            /monday1  expires in  13d
89            /tuesday1  expires in  13d 
90            /wednesday1  expires in  13d
91            /thursday1  expires in  13d
92            /friday1  expires in  13d
93    /sunday2  expires in  27d
94            /monday2  expires in  13d
95            /tuesday2  expires in  13d
96            /wednesday2  expires in  13d
97            /thursday2  expires in  13d
98            /friday2  expires in  13d
99    /sunday3  expires in  27d
100            /monday1  expires in  13d
101            /tuesday1  expires in  13d 
102            /wednesday1  expires in  13d
103            /thursday1  expires in  13d
104            /friday1  expires in  13d
105    /sunday4  expires in  27d
106            /monday2  expires in  13d
107            /tuesday2  expires in  13d
108            /wednesday2  expires in  13d
109            /thursday2  expires in  13d
110            /friday2  expires in  13d
111
112 =head1 PRIVILEGE REQUIRED
113
114 The issuer must be listed in the F</usr/afs/etc/UserList> file on every
115 machine where the Backup Server is running, or must be logged onto a
116 server machine as the local superuser C<root> if the B<-localauth> flag is
117 included.
118
119 =head1 SEE ALSO
120
121 L<backup(8)>,
122 L<backup_adddump(8)>,
123 L<backup_deldump(8)>
124
125 =head1 COPYRIGHT
126
127 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
128
129 This documentation is covered by the IBM Public License Version 1.0.  It was
130 converted from HTML to POD by software written by Chas Williams and Russ
131 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.