[hcoop/debian/openafs.git] / doc / man-pages / pod1 / pts_rename.pod.in

=head1 NAME

pts_rename - Changes the name of a Protection Database entry

=head1 SYNOPSIS

=for html
<div class="synopsis">

B<pts rename> S<<< B<-oldname> <I<old name>> >>> S<<< B<-newname> <I<new name>> >>>
    S<<< [B<-cell> <I<cell name>>] >>>  [B<-noauth>]  [B<-localauth>]  
    [B<-force>] [B<-help>] [B<-auth>] [B<-encrypt>]
    S<<< [B<-config> <I<config directory>>] >>>

B<pts ren> S<<< B<-o> <I<old name>> >>> S<<< B<-ne> <I<new name>> >>> S<<< [B<-c> <I<cell name>>] >>>
    [B<-no>] [B<-l>] [B<-f>] [B<-h>] [B<-a>] [B<-e>]
    S<<< [B<-co> <I<config directory>>] >>>

=for html
</div>

=head1 DESCRIPTION

The B<pts rename> command changes the name of the user, machine, or group
entry specified by the B<-oldname> argument to the name specified by the
B<-newname> argument. It is not possible to change a user or machine
entry's name to look like a regular group entry's name (have a colon in
it).

Members of the system:administrators group can change a regular group name
into a prefix-less name and vice versa. When changing a prefix-less group
name into a regular group name or a regular group name to another regular
group name, the owner field of the new name (the part before the colon)
must correctly reflect the group's owner.

Changing a regular group's owner with the B<pts chown> command
automatically changes the owner field (the part before the colon) of the
group's name, but does not change the owner field of any groups owned by
the group. Use this command to rename those groups to a form that
accurately reflects their ownership.

=head1 CAUTIONS

By convention, many aspects of an AFS user account have the same name as
the user's Protection Database entry, including the Authentication
Database entry, volume, and mount point. When using this command to change
a user name, also change the names of all related entities to maintain
consistency. For instructions, see the chapter on user accounts in the
I<OpenAFS Administration Guide>.

=head1 OPTIONS

=over 4

=item B<-oldname> <I<old name>>

Specifies the current full name of the entry.

=item B<-newname> <I<new name>>

Specifies the new full name for the entry. For regular groups, the owner
field (the part before the colon) of the new name must reflect the actual
ownership of the group.

=include fragments/pts-common.pod

=back

=head1 EXAMPLES

The following example changes the name of the group staff, owned by the
privileged user C<admin>, to C<admin:staff>:

   % pts rename -oldname staff -newname admin:staff

The following example changes the name of the group C<admin:finance> to
the group C<finance>. The issuer must belong to the system:administrators
group.

   % pts rename -oldname admin:finance -newname finance

=head1 PRIVILEGE REQUIRED

To change a regular group name to a prefix-less name or vice versa, or to
change a user or machine entry's name, the issuer must belong to the
system:administrators group.

To change a group name to a new name of the same type (regular or
prefix-less), the issuer must own the group or belong to the
system:administrators group.

=head1 SEE ALSO

L<pts(1)>,
L<pts_chown(1)>

=head1 COPYRIGHT

IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.

This documentation is covered by the IBM Public License Version 1.0.  It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.
Commit	Line	Data
805e021f CE	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>] [B<-auth>] [B<-encrypt>]
	13	S<<< [B<-config> <I<config directory>>] >>>
	14
	15	B<pts ren> S<<< B<-o> <I<old name>> >>> S<<< B<-ne> <I<new name>> >>> S<<< [B<-c> <I<cell name>>] >>>
	16	[B<-no>] [B<-l>] [B<-f>] [B<-h>] [B<-a>] [B<-e>]
	17	S<<< [B<-co> <I<config directory>>] >>>
	18
	19	=for html
	20	</div>
	21
	22	=head1 DESCRIPTION
	23
	24	The B<pts rename> command changes the name of the user, machine, or group
	25	entry specified by the B<-oldname> argument to the name specified by the
	26	B<-newname> argument. It is not possible to change a user or machine
	27	entry's name to look like a regular group entry's name (have a colon in
	28	it).
	29
	30	Members of the system:administrators group can change a regular group name
	31	into a prefix-less name and vice versa. When changing a prefix-less group
	32	name into a regular group name or a regular group name to another regular
	33	group name, the owner field of the new name (the part before the colon)
	34	must correctly reflect the group's owner.
	35
	36	Changing a regular group's owner with the B<pts chown> command
	37	automatically changes the owner field (the part before the colon) of the
	38	group's name, but does not change the owner field of any groups owned by
	39	the group. Use this command to rename those groups to a form that
	40	accurately reflects their ownership.
	41
	42	=head1 CAUTIONS
	43
	44	By convention, many aspects of an AFS user account have the same name as
	45	the user's Protection Database entry, including the Authentication
	46	Database entry, volume, and mount point. When using this command to change
	47	a user name, also change the names of all related entities to maintain
	48	consistency. For instructions, see the chapter on user accounts in the
	49	I<OpenAFS Administration Guide>.
	50
	51	=head1 OPTIONS
	52
	53	=over 4
	54
	55	=item B<-oldname> <I<old name>>
	56
	57	Specifies the current full name of the entry.
	58
	59	=item B<-newname> <I<new name>>
	60
	61	Specifies the new full name for the entry. For regular groups, the owner
	62	field (the part before the colon) of the new name must reflect the actual
	63	ownership of the group.
	64
65	=include fragments/pts-common.pod
66
67	=back
68
69	=head1 EXAMPLES
70
71	The following example changes the name of the group staff, owned by the
72	privileged user C<admin>, to C<admin:staff>:
73
74	% pts rename -oldname staff -newname admin:staff
75
76	The following example changes the name of the group C<admin:finance> to
77	the group C<finance>. The issuer must belong to the system:administrators
78	group.
79
80	% pts rename -oldname admin:finance -newname finance
81
82	=head1 PRIVILEGE REQUIRED
83
84	To change a regular group name to a prefix-less name or vice versa, or to
85	change a user or machine entry's name, the issuer must belong to the
86	system:administrators group.
87
88	To change a group name to a new name of the same type (regular or
89	prefix-less), the issuer must own the group or belong to the
90	system:administrators group.
91
92	=head1 SEE ALSO
93
94	L<pts(1)>,
95	L<pts_chown(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.