doc: Make all vos pages =include common options
[openafs.git] / doc / man-pages / pod1 / vos_convertROtoRW.pod.in
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 =include fragments/vos-common.pod
69
70 =back
71
72 =head1 EXAMPLES
73
74 The following example converts the read-only volume test3.readonly in
75 partition vicepb on server1 to a read-write volume:
76
77    % vos convertROtoRW server1 b test3.readonly
78
79 =head1 PRIVILEGE REQUIRED
80
81 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
82 machine specified with the B<-server> argument and
83 on each database server machine.  If the B<-localauth> flag is included,
84 the issuer must instead be logged on to a server machine as the local
85 superuser C<root>.
86
87 =head1 SEE ALSO
88
89 L<vos(1)>
90
91 =head1 COPYRIGHT
92
93 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
94
95 This documentation is covered by the BSD License as written in the
96 doc/LICENSE file. This man page was written by Jason Edgecombe for
97 OpenAFS.