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