doc/man-pages/pod1/vos_rename.pod

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