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