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