mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 07:20:11 +00:00
e3dfba8e6c
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.
187 lines
6.8 KiB
Plaintext
187 lines
6.8 KiB
Plaintext
=head1 NAME
|
|
|
|
backup adddump - Defines a dump level in the dump hierarchy
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<backup adddump -dump> <I<dump level name>>+ [-expires <I<expiration date>>+]
|
|
[B<-localauth>] [B<-cell> <I<cell name>>] [B<-help>]
|
|
|
|
B<backup addd -d> <I<dump level name>>+ [B<-e> <I<expiration date>>+] [-l]
|
|
[B<-c> <I<cell name>>] [B<-h>]
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The backup adddump command creates one or more dump levels in
|
|
the dump hierarchy stored in the Backup Database, and optionally assigns an
|
|
expiration date to each one. All of the dump levels in the Backup
|
|
Database collectively constitute the dump hierarchy.
|
|
|
|
Use the -expires argument to associate an expiration date with
|
|
each dump level. When the Backup System subsequently creates a dump at
|
|
the dump level, it uses the specified value to derive the dump's
|
|
expiration date, which it records on the label of the tape (or backup data
|
|
file). The Backup System refuses to overwrite a tape until after the
|
|
latest expiration date of any dump that the tape contains, unless the
|
|
B<backup labeltape> command is used to relabel the tape. If a
|
|
dump level does not have an expiration date, the Backup System treats dumps
|
|
created at the level as expired as soon as it creates them.
|
|
|
|
(Note that the Backup System does not automatically remove a dump's
|
|
record from the Backup Database when the dump reaches its expiration date, but
|
|
only if the tape that contains the dump is recycled or relabeled. To
|
|
remove expired and other obsolete dump records, use the B<backup
|
|
deletedump> command.)
|
|
|
|
Define either an absolute or relative expiration date:
|
|
|
|
=over 4
|
|
|
|
=item *
|
|
|
|
An absolute expiration date defines the month/day/year (and, optionally,
|
|
hour and minutes) at which a dump expires. If the expiration date
|
|
predates the dump creation time, the Backup System immediately treats the dump
|
|
as expired.
|
|
|
|
|
|
=item *
|
|
|
|
A relative date defines the number of years, months, or days (or a
|
|
combination of the three) after the dump's creation that it
|
|
expires. When the Backup System creates a dump at the dump level, it
|
|
calculates an actual expiration date by adding the relative date to the start
|
|
time of the dump operation.
|
|
|
|
|
|
=back
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item -dump
|
|
|
|
Names each dump level to add to the dump hierarchy. Precede full
|
|
dump level names with a slash (for example, B</full>). Indicate
|
|
an incremental dump level by preceding it with an ordered list of the dump
|
|
levels directly above it in the hierarchy (its parent dump levels); use
|
|
the slash as a separator. The parent dump levels must already
|
|
exist. For example, the dump levels B</full> and
|
|
B</full/incremental1> must exist when the incremental dump level
|
|
B</full/incremental1/incremental2> is created.
|
|
|
|
Dump level names can have any number of levels, but cannot exceed 256
|
|
characters in length, including the slashes. The maximum length for any
|
|
single level (the text between slashes) is 28 characters, not including the
|
|
preceding slash.
|
|
|
|
All alphanumeric characters are allowed in dump level names. Do not
|
|
use the period (B<.>), however, because it is the separator
|
|
between the volume set name and dump level name in the dump name assigned
|
|
automatically by the B<backup dump> command. It is best not to
|
|
include other metacharacters either; if using them, enclose them in
|
|
double quotes (B<" ">) when issuing the B<backup adddump>
|
|
command outside interactive mode.
|
|
|
|
=item -expires
|
|
|
|
Defines the absolute or relative expiration date to associate with each
|
|
dump level named by the B<-dump> argument. Absolute expiration
|
|
dates have the following format:
|
|
|
|
[B<at>] {B<NEVER> | I<mm>B</>I<dd>B</>I<yyyy> [I<hh>:I<MM>] }
|
|
|
|
where the optional word at is followed either by the string
|
|
B<NEVER>, which indicates that dumps created at the dump level never
|
|
expire, or by a date value with a required portion (I<mm> for month,
|
|
I<dd> for day, and I<yyyy> for year) and an optional portion
|
|
(I<hh> for hours and I<MM> for minutes).
|
|
|
|
Omit the I<hh>:I<MM> portion to use the default of
|
|
midnight (00:00 hours), or provide a value in 24-hour format (for
|
|
example, B<20:30> is 8:30 p.m.).
|
|
Valid values for the year range from B<1970> to B<2037>;
|
|
higher values are not valid because the latest possible date in the standard
|
|
UNIX representation is in February 2038. The command interpreter
|
|
automatically reduces later dates to the maximum value.
|
|
|
|
Relative expiration dates have the following format:
|
|
|
|
[B<in>] [I<years>B<y>] [I<months>B<m>] [I<days>d]
|
|
|
|
where the optional word in is followed by at least one of a
|
|
number of years (maximum B<9999>) followed by the letter B<y>,
|
|
a number of months (maximum B<12>) followed by the letter
|
|
B<m>, or a number of days (maximum B<31>) followed by the
|
|
letter B<d>. If providing more than one of the three, list them
|
|
in the indicated order. If the date that results from adding the
|
|
relative expiration value to a dump's creation time is later than the
|
|
latest possible date in the UNIX time representation, the Backup System
|
|
automatically reduces it to that date.
|
|
|
|
=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 EXAMPLES
|
|
|
|
The following command defines a full dump called /1999 with a
|
|
relative expiration date of one year:
|
|
|
|
% backup adddump -dump /1999 -expires in 1y
|
|
|
|
The following command defines an incremental dump called
|
|
B</sunday1/monday>1 with a relative expiration date of 13 days:
|
|
|
|
% backup adddump -dump /sunday1/monday1 -expires in 13d
|
|
|
|
The following command defines two dump incremental dump levels,
|
|
B</Monthly/Week1> and B</Monthly/Week2>. Their parent,
|
|
the full dump level B</Monthly>, must already exist. The
|
|
expiration date for both levels is 12:00 a.m. on 1 January
|
|
2000.
|
|
|
|
% backup adddump -dump /Monthly/Week1 /Monthly/Week2 -expires at 01/01/2000
|
|
|
|
=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_deldump(1)>,
|
|
L<backup_deletedump(1)>,
|
|
L<backup_listdumps(1)>,
|
|
L<backup_setexp(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.
|