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