mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 15:30:14 +00:00
03b9fcc883
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.
98 lines
2.9 KiB
Plaintext
98 lines
2.9 KiB
Plaintext
=head1 NAME
|
|
|
|
vos lock - Locks a VLDB volume entry
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<vos lock> B<-id> <I<volume name or ID>> [B<-cell> <I<cell name>>]
|
|
[B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>]
|
|
|
|
B<vos lo> B<-i> <I<volume name or ID>> [B<-c> <I<cell name>>] [B<-n>]
|
|
[B<-l>] [B<-v>] [B<-h>]
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<vos lock> command locks the Volume Location Database (VLDB) entry
|
|
for the indicated volume, blocking any operation that requires a write to
|
|
that entry. The lock applies to all of the volume versions associated with
|
|
the entry, not just the one specified with the B<-id> argument.
|
|
|
|
To unlock a single VLDB entry, use the B<vos unlock> command. To unlock
|
|
several entries, or all locked entries in the VLDB, use the B<vos
|
|
unlockvldb> command.
|
|
|
|
=head1 CAUTIONS
|
|
|
|
Do not use this command in normal circumstances. It is useful for
|
|
guaranteeing that the volume stays unchanged when there is reason to
|
|
believe that volume operations cannot properly lock VLDB volume entries as
|
|
they normally do to synchronize with one another.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item B<-id> <I<volume name or ID>>
|
|
|
|
Specifies either the complete name or volume ID number of a volume of the
|
|
any of the three types.
|
|
|
|
=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<vos(1)>.
|
|
|
|
=item B<-noauth>
|
|
|
|
Assigns the unprivileged identity C<anonymous> to the issuer. Do not
|
|
combine this flag with the B<-localauth> flag. For more details, see
|
|
L<vos(1)>.
|
|
|
|
=item B<-localauth>
|
|
|
|
Constructs a server ticket using a key from the local
|
|
F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
|
|
to the Volume Server and Volume Location Server during mutual
|
|
authentication. Do not combine this flag with the B<-cell> argument or
|
|
B<-noauth> flag. For more details, see L<vos(1)>.
|
|
|
|
=item B<-verbose>
|
|
|
|
Produces on the standard output stream a detailed trace of the command's
|
|
execution. If this argument is omitted, only warnings and error messages
|
|
appear.
|
|
|
|
=item B<-help>
|
|
|
|
Prints the online help for this command. All other valid options are
|
|
ignored.
|
|
|
|
=back
|
|
|
|
=head1 EXAMPLES
|
|
|
|
The following command locks the VLDB entry for C<user.terry>.
|
|
|
|
% vos lock user.terry
|
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
The issuer must be listed in the F</usr/afs/etc/UserList> file on the
|
|
machine specified with the B<-server> argument and on each database server
|
|
machine. If the B<-localauth> flag is included, the issuer must instead be
|
|
logged on to a server machine as the local superuser C<root>.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<vos(1)>,
|
|
L<vos_unlock(1)>,
|
|
L<vos_unlockvldb(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.
|