openafs/doc/man-pages/pod8/backup_delvolentry.pod
Russ Allbery 03b9fcc883 man1-editing-pass-20051209
Complete an initial editing and cleanup pass for all section one man pages.
Fix various conversion problems, formatting inconsistencies, and obvious
problems.  Please note that no editing for content has yet been done; this
is solely editing for formatting and correct conversion to POD.

Also, add some additional section five man pages that were omitted from the
first conversion run due to unusual file names, and globally replace
CAVEATS with CAUTIONS in the man pages to match the original section name.

The section one man pages should now be in reasonable shape and ready for
additional review and further updates, although there are probably still
remaining obvious problems.

====================
This delta was composed from multiple commits as part of the CVS->Git migration.
The checkin message with each commit was inconsistent.
The following are the additional commit messages.
====================

This file got the wrong name when it was originally committed.  Fix.
2005-12-09 14:48:56 +00:00

95 lines
2.6 KiB
Plaintext

=head1 NAME
backup delvolentry - Deletes a volume entry from a volume set
=head1 SYNOPSIS
B<backup delvolentry -name> <I<volume set name>> -entry <I<volume set index>>
[B<-localauth>] [B<-cell> <I<cell name>>] [B<-help>]
B<backup delvole -n> <I<volume set name>> -e <I<volume set index>>
[B<-l>] [B<-c> <I<cell name>>] [B<-h>]
=head1 DESCRIPTION
The backup delvolentry command deletes the indicated volume
entry from the volume set specified with the B<-name> argument.
Use the B<-entry> argument to identify the volume entry by its index
number. To display the index numbers, use the B<backup
listvolsets> command.
If there are any remaining volume entries with index numbers higher than
the deleted entry, their indexes are automatically decremented to eliminate
any gaps in the indexing sequence.
=head1 CAUTIONS
Deleting volume entries from a temporary volume set is possible only within
the interactive session in which the volume set was created.
=head1 OPTIONS
=over 4
=item -name
Names the volume set from which to delete a volume entry.
=item -entry
Specifies the index number of the volume entry to delete. Use the
B<backup listvolsets> command to display the index numbers for a
volume set's volume entries.
=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 deletes the fourth volume entry from the volume set
called B<sys>:
% backup delvolentry -name sys -entry 4
=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_addvolentry(1)>,
L<backup_addvolset(1)>,
L<backup_delvolset(1)>,
L<backup_listvolsets(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.