doc: vos manpage fixes
[openafs.git] / doc / man-pages / pod1 / vos_convertROtoRW.pod
1 =head1 NAME
2
3 vos_convertROtoRW - Converts a Read-Only volume into a Read/Write volume
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos convertROtoRW> S<<< [B<-server>] <I<machine name>> >>>
11    S<<< [B<-partition>] <I<partition name>> >>>
12    S<<< [B<-id>] <I<volume name or ID>> >>> [B<-force>]
13    S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
14    [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
15    S<<< [B<-config> <I<config directory>>] >>>
16    [B<-help>]
17
18 B<vos con> S<<< [B<-s>] <I<machine name>> >>>
19    S<<< [B<-p>] <I<partition name>> >>>
20    S<<< [B<-i>] <I<volume name or ID>> >>> [B<-f>]
21    S<<< [B<-c> <I<cell name>>] >>> [B<-noa>] [B<-l>]
22    [B<-v>] [B<-e>] [B<-nor>]
23    S<<< [B<-co> <I<config directory>>] >>>
24    [B<-h>]
25
26 =for html
27 </div>
28
29 =head1 DESCRIPTION
30
31 B<vos convertROtoRW> converts a Read-Only volume into a Read/Write volume
32 when the original Read/Write volume is no longer available.  It's normal use
33 is to recover the Read/Write volume from a replica after a failed disk,
34 failed server, or accidental deletion.
35
36 =head1 CAUTIONS
37
38 The command name is case-sensitive.  It must be issued with the capital "RO"
39 and "RW".
40
41 =head1 OPTIONS
42
43 =over 4
44
45 =item B<-server> <I<server name>>
46
47 Identifies the file server machine that houses the Read-Only volume which
48 will be converted.  Provide the machine's IP address or its host name
49 (either fully qualified or using an unambiguous abbreviation).  For details,
50 see L<vos(1)>.
51
52 =item B<-partition> <I<partition name>>
53
54 Identifies the partition on the file server machine that houses the
55 Read-Only volume which will be converted.  Provide the full partition name
56 (for, example, B</vicepa>) or one of the abbreviated forms described in
57 L<vos(1)>.
58
59 =item B<-id> <I<volume ID>>
60
61 Specifies either the complete name or volume ID number of a Read/Write
62 volume.
63
64 =item B<-force>
65
66 Don't ask for confirmation.
67
68 =item B<-cell> <I<cell name>>
69
70 Names the cell in which to run the command. Do not combine this argument
71 with the B<-localauth> flag. For more details, see L<vos(1)>.
72
73 =item B<-noauth>
74
75 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
76 combine this flag with the B<-localauth> flag. For more details, see
77 L<vos(1)>.
78
79 =item B<-localauth>
80
81 Constructs a server ticket using a key from the local
82 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
83 to the Volume Server and Volume Location Server during mutual
84 authentication. Do not combine this flag with the B<-cell> argument or
85 B<-noauth> flag. For more details, see L<vos(1)>.
86
87 =item B<-verbose>
88
89 Produces on the standard output stream a detailed trace of the command's
90 execution. If this argument is omitted, only warnings and error messages
91 appear.
92
93 =item B<-encrypt>
94
95 Encrypts the command so that the operation's results are not transmitted
96 across the network in clear text. This option is available in OpenAFS
97 versions 1.4.11 or later and 1.5.60 or later.
98
99 =item B<-noresolve>
100
101 Shows all servers as IP addresses instead of the DNS name. This is very
102 useful when the server address is registered as 127.0.0.1 or when dealing
103 with multi-homed servers. This option is available in OpenAFS
104 versions 1.4.8 or later and 1.5.35 or later.
105
106 =item B<-help>
107
108 Prints the online help for this command. All other valid options are
109 ignored.
110
111 =back
112
113 =head1 EXAMPLES
114
115 The following example converts the read-only volume test3.readonly in
116 partition vicepb on server1 to a read-write volume:
117
118    % vos convertROtoRW server1 b test3.readonly
119
120 =head1 PRIVILEGE REQUIRED
121
122 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
123 machine specified with the B<-server> argument and
124 on each database server machine.  If the B<-localauth> flag is included,
125 the issuer must instead be logged on to a server machine as the local
126 superuser C<root>.
127
128 =head1 SEE ALSO
129
130 L<vos(1)>
131
132 =head1 COPYRIGHT
133
134 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
135
136 This documentation is covered by the BSD License as written in the
137 doc/LICENSE file. This man page was written by Jason Edgecombe for
138 OpenAFS.