mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 15:30:14 +00:00
fc5acc0151
Implement proper synopsis wrapping for HTML generation. This was done in three pieces. First, add HTML-specific tags to the POD to mark the synopsis for HTML purposes so that we can apply style information to it. Second, update the style sheet to indent all lines except for the first in the synopsis section. Third, add the appropriate S<> tags around option and argument pairs so that we don't wrap between the option and its argument. Unfortunately, due to the <I<foo>> style that looks nicer for other reasons, we have to use the very verbose S<<< >>>. Oh well.
198 lines
6.6 KiB
Plaintext
198 lines
6.6 KiB
Plaintext
=head1 NAME
|
|
|
|
backup addvolentry - Defines a volume entry in a volume set
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
=for html
|
|
<div class="synopsis">
|
|
|
|
B<backup addvolentry> S<<< B<-name> <I<volume set name>> >>>
|
|
S<<< B<-server> <I<machine name>> >>> S<<< B<-partition> <I<partition name>> >>>
|
|
S<<< B<-volumes> <I<volume name (regular expression)>> >>>
|
|
[B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
|
|
|
|
B<backup addvole> S<<< B<-n> <I<volume set name>> >>> S<<< B<-s> <I<machine name>> >>>
|
|
S<<< B<-p> <I<partition name>> >>> S<<< B<-v> <I<volume name (regular expression)>> >>>
|
|
[B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
|
|
|
|
=for html
|
|
</div>
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<backup addvolentry> command adds a volume entry definition to the
|
|
existing volume set named by the B<-name> argument. A volume entry
|
|
definition can match one or more volumes, depending on the combination of
|
|
the B<-server>, B<-partition>, and B<-volumes> arguments.
|
|
|
|
For the B<-server> and B<-partition> arguments, provide either
|
|
|
|
=over 4
|
|
|
|
=item *
|
|
|
|
The name of one machine or partition.
|
|
|
|
=item *
|
|
|
|
The metacharacter expression .* (period and asterisk), which matches every
|
|
machine name or partition name in the Volume Location Database (VLDB).
|
|
|
|
=back
|
|
|
|
For the B<-volumes> argument, specify a combination of alphanumeric
|
|
characters and one or more metacharacters to wildcard part or all of the
|
|
volume name. L<OPTIONS> lists the acceptable metacharacters.
|
|
|
|
=head1 CAUTIONS
|
|
|
|
It is best to issue this command in interactive mode. If issuing it at the
|
|
shell prompt, enclose any strings containing metacharacters in double
|
|
quotes, or escape the metacharacters with other delimiters, to prevent the
|
|
shell from interpreting them. Adding volume entries to a temporary volume
|
|
set is possible only within the interactive session in which the volume
|
|
set was created.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item B<-name> <I<volume set name>>
|
|
|
|
Names the volume set to which to add this volume entry definition. The
|
|
volume set must already exist (use the B<backup addvolset> command to
|
|
create it).
|
|
|
|
=item B<-server> <I<machine name>>
|
|
|
|
Defines the set of one or more file server machines that house the volumes
|
|
in the volume entry. Provide either one fully-qualified hostname (such as
|
|
C<fs1.abc.com>) or the metacharacter expression C<.*> (period and
|
|
asterisk), which matches all machine names in the VLDB.
|
|
|
|
=item B<-partition> <I<partition name>>
|
|
|
|
Defines the set of one or more partitions that house the volumes in the
|
|
volume entry. Provide either one complete partition name (such as
|
|
C</vicepa>) or the metacharacter expression C<.*> (period and asterisk),
|
|
which matches all partition names.
|
|
|
|
=item B<-volumes> <I<volume name>>
|
|
|
|
Defines the set of one or more volumes included in the volume
|
|
entry. Specify the volumes by name, by using any combination of regular
|
|
alphanumeric characters and one or more of the following metacharacter
|
|
expressions:
|
|
|
|
=over 4
|
|
|
|
=item .
|
|
|
|
The period matches any single character.
|
|
|
|
=item *
|
|
|
|
The asterisk matches zero or more instances of the preceding character.
|
|
Combine it with any other alphanumeric character or metacharacter.
|
|
|
|
=item [ ]
|
|
|
|
Square brackets around a list of characters match a single instance of any
|
|
of the characters, but no other characters; for example, C<[abc]> matches
|
|
a single C<a> or C<b> or C<c>, but not C<d> or C<A>. This expression can
|
|
be combined with the asterisk.
|
|
|
|
=item ^
|
|
|
|
The caret, when used as the first character in a square-bracketed set,
|
|
designates a match with any single character I<except> the characters that
|
|
follow it; for example, C<[^a]> matches any single character except
|
|
lowercase C<a>. This expression can be combined with the asterisk.
|
|
|
|
=item \
|
|
|
|
A backslash preceding any of the metacharacters in this list makes it
|
|
match its literal value only. For example, the expression C<\.> (backslash
|
|
and period) matches a single period, C<\*> a single asterisk, and C<\\> a
|
|
single backslash. Such expressions can be combined with the asterisk (for
|
|
example, C<\.*> matches any number of periods).
|
|
|
|
=back
|
|
|
|
Perhaps the most common metacharacter expression is the period followed by
|
|
an asterisk (C<.*>). This expression matches any string of any length,
|
|
because the period matches any character and the asterisk means any number
|
|
of that character. As mentioned, it is the only acceptable metacharacter
|
|
expression for the B<-server> and B<-partition> arguments. In a volume
|
|
definition it can stand alone (in which case it matches every volume
|
|
listed in the VLDB), or can combine with regular characters. The following
|
|
example matches any volume name that begins with the string C<user> and
|
|
ends with C<backup>:
|
|
|
|
user.*backup
|
|
|
|
=item B<-localauth>
|
|
|
|
Constructs a server ticket using a key from the local
|
|
F</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 L<backup(8)>.
|
|
|
|
=item B<-cell> <I<cell name>>
|
|
|
|
Names the cell in which to run the command. Do not combine this argument
|
|
with the B<-localauth> flag. For more details, see L<backup(8)>.
|
|
|
|
=item B<-help>
|
|
|
|
Prints the online help for this command. All other valid options are
|
|
ignored.
|
|
|
|
=back
|
|
|
|
=head1 EXAMPLES
|
|
|
|
The following command adds a volume entry to the volume set called
|
|
C<sys>. The entry matches all volumes on any machine or partition whose
|
|
names begin with the string C<sun4x_56> followed by a period:
|
|
|
|
backup> addvolentry sys .* .* sun4x_56\..*
|
|
|
|
The following command adds a volume entry to the volume set called C<fs2>,
|
|
to match all volumes on the F</vicepb> partition of file server machine
|
|
C<fs2.abc.com>. Because it is issued at the shell prompt, double quotes
|
|
surround the metacharacters in the B<-volumes> argument. (The command is
|
|
shown here on two lines only for legibility reasons.)
|
|
|
|
% backup addvolentry -name fs2 -server fs2.abc.com \
|
|
-partition /vicepb -volumes ".*"
|
|
|
|
The chapter in the I<IBM AFS Administration Guide> about configuring the
|
|
AFS Backup System presents additional examples as well as advice on
|
|
grouping volumes.
|
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
The issuer must be listed in the F</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 C<root> if the B<-localauth> flag is
|
|
included.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<backup(8)>,
|
|
L<backup_addvolset(8)>,
|
|
L<backup_delvolentry(8)>,
|
|
L<backup_delvolset(8)>,
|
|
L<backup_listvolsets(8)>
|
|
|
|
=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.
|