vos: fix name availability check in vos rename
[openafs.git] / doc / man-pages / pod1 / vos_rename.pod.in
1 =head1 NAME
2
3 vos_rename - Renames a volume
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos rename> S<<< B<-oldname> <I<old volume name>> >>>
11     S<<< B<-newname> <I<new volume name>> >>>
12     S<<< [B<-cell> <I<cell name>>] >>>
13     [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 ren> S<<< B<-o> <I<old volume name>> >>>
19     S<<< B<-ne> <I<new volume name>> >>>
20     [-c <I<cell name>>] [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
21     S<<< [B<-co> <I<config directory>>] >>>
22     [B<-h>]
23
24 =for html
25 </div>
26
27 =head1 DESCRIPTION
28
29 The B<vos rename> command changes the name of the read/write volume
30 specified with the B<-oldname> argument to the name specified with the
31 B<-newname> argument. The names of the read/write's read-only copies and
32 backup copy, if any, change automatically to match.
33
34 After issuing this command, remember to correct any mount points that
35 refer to the old volume name, by removing the old mount point with the
36 B<fs rmmount> command and creating a new one with the B<fs mkmount>
37 command.
38
39 =head1 OPTIONS
40
41 =over 4
42
43 =item B<-oldname> <I<old volume name or id>>
44
45 Is the current name or numeric id of the read/write volume to be renamed.
46
47 =item B<-newname> <I<new volume name>>
48
49 Is the desired new name for the volume.
50
51 The new name may be the same as the current volume name in the VLDB
52 in order to complete a previously interrupted volume rename.
53
54 =include fragments/vos-common.pod
55
56 =back
57
58 =head1 OUTPUT
59
60 The B<vos rename> command produces no output if the command succeeds.
61
62 If the volume named by the B<-oldname> argument does not exist, the
63 following message appears:
64
65    vos: Could not find entry for volume <old volume name>.
66
67 =head1 EXAMPLES
68
69 The following example changes the mistaken volume name C<sun4x_56.afsws>
70 to the correct alternative C<sun4x_56.usr.afsws>.
71
72    % vos rename -oldname sun4x_56.afsws -newname sun4x_56.usr.afsws
73
74 =head1 PRIVILEGE REQUIRED
75
76 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
77 machine specified with the B<-server> argument and on each database server
78 machine. If the B<-localauth> flag is included, the issuer must instead be
79 logged on to a server machine as the local superuser C<root>.
80
81 =head1 SEE ALSO
82
83 L<vos(1)>
84
85 =head1 COPYRIGHT
86
87 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
88
89 This documentation is covered by the IBM Public License Version 1.0.  It was
90 converted from HTML to POD by software written by Chas Williams and Russ
91 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.