doc/man-pages/pod1/pts_rename.pod

   1 =head1 NAME
   2
   3 pts_rename - Changes the name of a Protection Database entry
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<pts rename> S<<< B<-oldname> <I<old name>> >>> S<<< B<-newname> <I<new name>> >>>
  11     S<<< [B<-cell> <I<cell name>>] >>>  [B<-noauth>]  [B<-force>]  [B<-help>]
  12
  13 B<pts ren> S<<< B<-o> <I<old name>> >>> S<<< B<-ne> <I<new name>> >>> S<<< [B<-c> <I<cell name>>] >>>
  14     [B<-no>] [B<-f>] [B<-h>]
  15
  16 =for html
  17 </div>
  18
  19 =head1 DESCRIPTION
  20
  21 The B<pts rename> command changes the name of the user, machine, or group
  22 entry specified by the B<-oldname> argument to the name specified by the
  23 B<-newname> argument. It is not possible to change a user or machine
  24 entry's name to look like a regular group entry's name (have a colon in
  25 it).
  26
  27 Members of the system:administrators group can change a regular group name
  28 into a prefix-less name and vice versa. When changing a prefix-less group
  29 name into a regular group name or a regular group name to another regular
  30 group name, the owner field of the new name (the part before the colon)
  31 must correctly reflect the group's owner.
  32
  33 Changing a regular group's owner with the B<pts chown> command
  34 automatically changes the owner field (the part before the colon) of the
  35 group's name, but does not change the owner field of any groups owned by
  36 the group. Use this command to rename those groups to a form that
  37 accurately reflects their ownership.
  38
  39 =head1 CAUTIONS
  40
  41 By convention, many aspects of an AFS user account have the same name as
  42 the user's Protection Database entry, including the Authentication
  43 Database entry, volume, and mount point. When using this command to change
  44 a user name, also change the names of all related entities to maintain
  45 consistency. For instructions, see the chapter on user accounts in the
  46 I<IBM AFS Administration Guide>.
  47
  48 =head1 OPTIONS
  49
  50 =over 4
  51
  52 =item B<-oldname> <I<old name>>
  53
  54 Specifies the current full name of the entry.
  55
  56 =item B<-newname> <I<new name>>
  57
  58 Specifies the new full name for the entry. For regular groups, the owner
  59 field (the part before the colon) of the new name must reflect the actual
  60 ownership of the group.
  61
  62 =item B<-cell> <I<cell name>>
  63
  64 Names the cell in which to run the command. For more details, see
  65 L<pts(1)>.
  66
  67 =item B<-noauth>
  68
  69 Assigns the unprivileged identity anonymous to the issuer. For more
  70 details, see L<pts(1)>.
  71
  72 =item B<-force>
  73
  74 Enables the command to continue executing as far as possible when errors
  75 or other problems occur, rather than halting execution at the first error.
  76
  77 =item B<-help>
  78
  79 Prints the online help for this command. All other valid options are
  80 ignored.
  81
  82 =back
  83
  84 =head1 EXAMPLES
  85
  86 The following example changes the name of the group staff, owned by the
  87 privileged user C<admin>, to C<admin:staff>:
  88
  89    % pts rename -oldname staff -newname admin:staff
  90
  91 The following example changes the name of the group C<admin:finance> to
  92 the group C<finance>. The issuer must belong to the system:administrators
  93 group.
  94
  95    % pts rename -oldname admin:finance -newname finance
  96
  97 =head1 PRIVILEGE REQUIRED
  98
  99 To change a regular group name to a prefix-less name or vice versa, or to
 100 change a user or machine entry's name, the issuer must belong to the
 101 system:administrators group.
 102
 103 To change a group name to a new name of the same type (regular or
 104 prefix-less), the issuer must own the group or belong to the
 105 system:administrators group.
 106
 107 =head1 SEE ALSO
 108
 109 L<pts(1)>,
 110 L<pts_chown(1)>
 111
 112 =head1 COPYRIGHT
 113
 114 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 115
 116 This documentation is covered by the IBM Public License Version 1.0.  It was
 117 converted from HTML to POD by software written by Chas Williams and Russ
 118 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.