doc: Make all vos pages =include common options
[openafs.git] / doc / man-pages / pod1 / vos_unlock.pod.in
1 =head1 NAME
2
3 vos_unlock - Unlocks a single VLDB entry
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos unlock> S<<< B<-id> <I<volume name or ID>> >>>
11     S<<< [B<-cell> <I<cell name>>] >>>
12     [B<-noauth>] [B<-localauth>]
13     [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
14     S<<< [B<-config> <I<config directory>>] >>>
15     [B<-help>]
16
17 B<vos unlock> S<<< B<-i> <I<volume name or ID>> >>>
18     S<<< [B<-c> <I<cell name>>] >>>
19     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
20     S<<< [B<-co> <I<config directory>>] >>>
21     [B<-h>]
22
23 =for html
24 </div>
25
26 =head1 DESCRIPTION
27
28 The B<vos unlock> command releases the lock on the Volume Location
29 Database (VLDB) entry for the indicated volume.
30
31 =head1 CAUTIONS
32
33 Do not user this command under normal circumstances.
34
35 It is useful if the VLDB entry is locked but there is no reason to suspect
36 inconsistency within the volume or between it and the VLDB. Note that it
37 is possible to list information from locked VLDB entries, even though they
38 cannot be manipulated in other ways.
39
40 The B<vos unlockvldb> command unlocks several VLDB entries at once, or
41 even the entire VLDB. The B<vos lock> command locks a VLDB entry so that
42 no one else can perform an action that requires writing the VLDB.
43
44 =head1 OPTIONS
45
46 =over 4
47
48 =item B<-id> <I<volume name or ID>>
49
50 Specifies either the complete name or volume ID number of a volume of any
51 of the three types.
52
53 =include fragments/vos-common.pod
54
55 =back
56
57 =head1 EXAMPLES
58
59 The following example unlocks the VLDB entry for the volume C<user.terry>.
60
61    % vos unlock user.terry
62
63 =head1 PRIVILEGE REQUIRED
64
65 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
66 machine specified with the B<-server> argument and on each database server
67 machine. If the B<-localauth> flag is included, the issuer must instead be
68 logged on to a server machine as the local superuser C<root>.
69
70 =head1 SEE ALSO
71
72 L<vos(1)>,
73 L<vos_lock(1)>,
74 L<vos_unlockvldb(1)>
75
76 =head1 COPYRIGHT
77
78 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
79
80 This documentation is covered by the IBM Public License Version 1.0.  It was
81 converted from HTML to POD by software written by Chas Williams and Russ
82 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.