openafs/doc/man-pages/pod8/backup_listdumps.pod
Russ Allbery e3dfba8e6c man-page-conversion-20051208
This is the initial conversion of the AFS Adminstrators Reference into POD
for use as man pages.  The man pages are now generated via pod2man from
regen.sh so that only those working from CVS have to have pod2man
available.  The Makefile only installs.  The pages have also been sorted
out into pod1, pod5, and pod8 directories, making conversion to the right
section of man page easier without maintaining a separate list and allowing
for names to be duplicated between pod5 and pod1 or pod8 (which will likely
be needed in a few cases).

This reconversion is done with a new script based on work by Chas Williams.
In some cases, the output is worse than the previous POD pages, but this is
a more comprehensive conversion.

This is only the first step, and this initial conversion has various
problems.  In addition, the file man pages that didn't have simple names
have not been converted in this pass and will be added later.  Some of the
man pages have syntax problems and all of them have formatting errors.  The
next editing pass, coming shortly, will clean up most of the remaining
mess.
2005-12-08 12:14:33 +00:00

134 lines
4.3 KiB
Plaintext

=head1 NAME
backup listdumps - Displays the dump hierarchy from the Backup Database
=head1 SYNOPSIS
B<backup listdumps> [B<-localauth>] [B<-cell> <I<cell name>>] [-help]
B<backup listd> [B<-l>] [B<-c> <I<cell name>>] [-h]
=head1 DESCRIPTION
The backup listdumps command displays the dump hierarchy from
the Backup Database.
=head1 OPTIONS
=over 4
=item -localauth
Constructs a server ticket using a key from the local
B</usr/afs/etc/KeyFile> file. The B<backup> command
interpreter presents it to the Backup Server, Volume Server and VL Server
during mutual authentication. Do not combine this flag with the
B<-cell> argument. For more details, see the introductory
B<backup> reference page.
=item -cell
Names the cell in which to run the command. Do not combine this
argument with the B<-localauth> flag. For more details, see the
introductory B<backup> reference page.
=item -help
Prints the online help for this command. All other valid options
are ignored.
=back
=head1 OUTPUT
The output displays the complete dump hierarchy and indicates the
relationship between full and incremental dump levels. Full dump levels
appear at the left margin. The hierarchy can include more than one full
dump level; each one defines a subhierarchy of dump levels that can be
used for dumping different volume sets.
Incremental dump levels appear below and indented to the right of their
parent dump levels, which can be either full or incremental. Since
multiple incremental dump levels can share the same parent, an incremental
dump level is not always directly below its parent; the amount of
indentation indicates the parent/child relationship.
If a dump level has an associated expiration date, it appears along with
the level name. Absolute expiration dates appear in the format
I<dump_level> expires at I<day month date time year>
and relative expiration dates in the format
I<dump_level> expires in {I<years>y | I<months>m | I<days>d}
to indicate the number of years, months, days, or combination of the three
after creation a dump expires when created at this level.
=head1 EXAMPLES
The following example depicts six dump hierarchies. The expiration
date for all incremental dump levels is 13 days so that the corresponding
tapes can be recycled two weeks after their creation. The expiration
dates for all full dump levels is 27 days so that the corresponding tapes can
be recycled four weeks after their creation.
% backup listdumps
/week1 expires in 27d
/tuesday expires in 13d
/thursday expires in 13d
/sunday expires in 13d
/tuesday expires in 13d
/thursday expires in 13d
/week3 expires in 27d
/tuesday expires in 13d
/thursday expires in 13d
/sunday expires in 13d
/tuesday expires in 13d
/thursday expires in 13d
/sunday1 expires in 27d
/monday1 expires in 13d
/tuesday1 expires in 13d
/wednesday1 expires in 13d
/thursday1 expires in 13d
/friday1 expires in 13d
/sunday2 expires in 27d
/monday2 expires in 13d
/tuesday2 expires in 13d
/wednesday2 expires in 13d
/thursday2 expires in 13d
/friday2 expires in 13d
/sunday3 expires in 27d
/monday1 expires in 13d
/tuesday1 expires in 13d
/wednesday1 expires in 13d
/thursday1 expires in 13d
/friday1 expires in 13d
/sunday4 expires in 27d
/monday2 expires in 13d
/tuesday2 expires in 13d
/wednesday2 expires in 13d
/thursday2 expires in 13d
/friday2 expires in 13d
=head1 PRIVILEGE REQUIRED
The issuer must be listed in the /usr/afs/etc/UserList file on
every machine where the Backup Server is running, or must be logged onto a
server machine as the local superuser B<root> if the
B<-localauth> flag is included.
=head1 SEE ALSO
L<backup(1)>,
L<backup_adddump(1)>,
L<backup_deldump(1)>
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
This documentation is covered by the IBM Public License Version 1.0. It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.