openafs/doc/man-pages/pod1/vos_unlock.pod.in
Andrew Deason ade56fa2f9 doc: Make all vos pages =include common options
Many manpages for "vos" subcommands were not using the "common" vos
fragments, and instead were just repeating the information directly in
their manpage. Make them all use the "common" vos fragment to avoid
duplication.

Change-Id: I62d84a1164b4ba46082e33a6d27fd24e3722014c
Reviewed-on: http://gerrit.openafs.org/10398
Reviewed-by: Derrick Brashear <shadow@your-file-system.com>
Tested-by: BuildBot <buildbot@rampaginggeek.com>
2013-11-04 09:32:57 -08:00

83 lines
2.2 KiB
Plaintext

=head1 NAME
vos_unlock - Unlocks a single VLDB entry
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<vos unlock> S<<< B<-id> <I<volume name or ID>> >>>
S<<< [B<-cell> <I<cell name>>] >>>
[B<-noauth>] [B<-localauth>]
[B<-verbose>] [B<-encrypt>] [B<-noresolve>]
S<<< [B<-config> <I<config directory>>] >>>
[B<-help>]
B<vos unlock> S<<< B<-i> <I<volume name or ID>> >>>
S<<< [B<-c> <I<cell name>>] >>>
[B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
S<<< [B<-co> <I<config directory>>] >>>
[B<-h>]
=for html
</div>
=head1 DESCRIPTION
The B<vos unlock> command releases the lock on the Volume Location
Database (VLDB) entry for the indicated volume.
=head1 CAUTIONS
Do not user this command under normal circumstances.
It is useful if the VLDB entry is locked but there is no reason to suspect
inconsistency within the volume or between it and the VLDB. Note that it
is possible to list information from locked VLDB entries, even though they
cannot be manipulated in other ways.
The B<vos unlockvldb> command unlocks several VLDB entries at once, or
even the entire VLDB. The B<vos lock> command locks a VLDB entry so that
no one else can perform an action that requires writing the VLDB.
=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 any
of the three types.
=include fragments/vos-common.pod
=back
=head1 EXAMPLES
The following example unlocks the VLDB entry for the volume C<user.terry>.
% vos unlock 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_lock(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.