doc: vos manpage fixes
[openafs.git] / doc / man-pages / pod1 / vos_unlock.pod
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 =item B<-cell> <I<cell name>>
54
55 Names the cell in which to run the command. Do not combine this argument
56 with the B<-localauth> flag. For more details, see L<vos(1)>.
57
58 =item B<-noauth>
59
60 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
61 combine this flag with the B<-localauth> flag. For more details, see
62 L<vos(1)>.
63
64 =item B<-localauth>
65
66 Constructs a server ticket using a key from the local
67 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
68 to the Volume Server and Volume Location Server during mutual
69 authentication. Do not combine this flag with the B<-cell> argument or
70 B<-noauth> flag. For more details, see L<vos(1)>.
71
72 =item B<-verbose>
73
74 Produces on the standard output stream a detailed trace of the command's
75 execution. If this argument is omitted, only warnings and error messages
76 appear.
77
78 =item B<-encrypt>
79
80 Encrypts the command so that the operation's results are not transmitted
81 across the network in clear text. This option is available in OpenAFS
82 versions 1.4.11 or later and 1.5.60 or later.
83
84 =item B<-noresolve>
85
86 Shows all servers as IP addresses instead of the DNS name. This is very
87 useful when the server address is registered as 127.0.0.1 or when dealing
88 with multi-homed servers. This option is available in OpenAFS
89 versions 1.4.8 or later and 1.5.35 or later.
90
91 =item B<-help>
92
93 Prints the online help for this command. All other valid options are
94 ignored.
95
96 =back
97
98 =head1 EXAMPLES
99
100 The following example unlocks the VLDB entry for the volume C<user.terry>.
101
102    % vos unlock user.terry
103
104 =head1 PRIVILEGE REQUIRED
105
106 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
107 machine specified with the B<-server> argument and on each database server
108 machine. If the B<-localauth> flag is included, the issuer must instead be
109 logged on to a server machine as the local superuser C<root>.
110
111 =head1 SEE ALSO
112
113 L<vos(1)>,
114 L<vos_lock(1)>,
115 L<vos_unlockvldb(1)>
116
117 =head1 COPYRIGHT
118
119 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
120
121 This documentation is covered by the IBM Public License Version 1.0.  It was
122 converted from HTML to POD by software written by Chas Williams and Russ
123 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.