4c79ca495089db56de5bd22f52f6b58dddc86050
[openafs.git] / doc / man-pages / pod1 / vos_rename.pod
1 =head1 NAME
2
3 vos rename - Renames a volume
4
5 =head1 SYNOPSIS
6
7 B<vos rename> B<-oldname> <I<old volume name>>
8     B<-newname> <I<new volume name>> [B<-cell> <I<cell name>>]
9     [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-help>]
10
11 B<vos ren> B<-o> <I<old volume name>> B<-ne> <I<new volume name>>
12     [-c <I<cell name>>] [B<-no>] [B<-l>] [B<-v>] [B<-h>]
13
14 =head1 DESCRIPTION
15
16 The B<vos rename> command changes the name of the read/write volume
17 specified with the B<-oldname> argument to the name specified with the
18 B<-newname> argument. The names of the read/write's read-only copies and
19 backup copy, if any, change automatically to match.
20
21 After issuing this command, remember to correct any mount points that
22 refer to the old volume name, by removing the old mount point with the
23 B<fs rmmount> command and creating a new one with the B<fs mkmount>
24 command.
25
26 =head1 OPTIONS
27
28 =over 4
29
30 =item B<-oldname> <I<old volume name>>
31
32 Is the current name of the read/write volume.
33
34 =item B<-newname> <I<new volume name>>
35
36 Is the desired new name for the volume.
37
38 =item B<-cell> <I<cell name>>
39
40 Names the cell in which to run the command. Do not combine this argument
41 with the B<-localauth> flag. For more details, see L<vos(1)>.
42
43 =item B<-noauth>
44
45 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
46 combine this flag with the B<-localauth> flag. For more details, see
47 L<vos(1)>.
48
49 =item B<-localauth>
50
51 Constructs a server ticket using a key from the local
52 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
53 to the Volume Server and Volume Location Server during mutual
54 authentication. Do not combine this flag with the B<-cell> argument or
55 B<-noauth> flag. For more details, see L<vos(1)>.
56
57 =item B<-verbose>
58
59 Produces on the standard output stream a detailed trace of the command's
60 execution. If this argument is omitted, only warnings and error messages
61 appear.
62
63 =item B<-help>
64
65 Prints the online help for this command. All other valid options are
66 ignored.
67
68 =back
69
70 =head1 OUTPUT
71
72 The B<vos rename> command produces no output if the command succeeds.
73
74 If the volume named by the B<-oldname> argument does not exist, the
75 following message appears:
76
77    vos: Could not find entry for volume <old volume name>.
78
79 =head1 EXAMPLES
80
81 The following example changes the mistaken volume name C<sun4x_56.afsws>
82 to the correct alternative C<sun4x_56.usr.afsws>.
83
84    % vos rename -oldname sun4x_56.afsws -newname sun4x_56.usr.afsws
85
86 =head1 PRIVILEGE REQUIRED
87
88 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
89 machine specified with the B<-server> argument and on each database server
90 machine. If the B<-localauth> flag is included, the issuer must instead be
91 logged on to a server machine as the local superuser C<root>.
92
93 =head1 SEE ALSO
94
95 L<vos(1)>
96
97 =head1 COPYRIGHT
98
99 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
100
101 This documentation is covered by the IBM Public License Version 1.0.  It was
102 converted from HTML to POD by software written by Chas Williams and Russ
103 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.