7932fec8b2c85f43d7a074f04b39a4d54f37d069
[openafs.git] / doc / man-pages / pod1 / pts_delete.pod.in
1 =head1 NAME
2
3 pts_delete - Deletes a Protection Database entry
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<pts delete> S<<< B<-nameorid> <I<user or group name or id>>+ >>>
11     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] 
12     [B<-force>] [B<-help>]
13
14 B<pts d> S<<< B<-na> <I<user or group name or id>>+ >>>
15     S<<< [B<-c> <I<cell name>>] >>> [B<-no>] [B<-l>] [B<-f>] [-h]
16
17 =for html
18 </div>
19
20 =head1 DESCRIPTION
21
22 The B<pts delete> command removes each entry specified by the B<-nameorid>
23 argument from the Protection Database. Deleting entries affects other
24 parts of the system in various ways:
25
26 =over 4
27
28 =item *
29
30 Deleted users and groups still appear on access control lists (ACLs), but
31 are listed by AFS UID or GID rather than by name, because there is no
32 longer an associated name to which to translate the ID. To remove these
33 obsolete entries from ACLs, use the B<fs cleanacl> command.
34
35 =item *
36
37 Deleting a user or machine's entry removes it from the membership list of
38 any group to which it belonged.
39
40 =item *
41
42 Deleting a group entry removes it from the membership list of any user or
43 machine entry that belonged to the group, and also increments the
44 group-creation quota of the group's creator by one, even if the creator no
45 longer owns the group.
46
47 =back
48
49 To remove a user or machine from a group without actually deleting the
50 entry, use the B<pts removeuser> command.
51
52 =head1 OPTIONS
53
54 =over 4
55
56 =item B<-nameorid> <I<user or group name or ID>>+
57
58 Specifies the name or AFS UID of each user, the name or AFS GID of each
59 group, or the IP address (complete or wildcard-style) or AFS UID of each
60 machine entry to delete. It is acceptable to mix users, machines, and
61 groups on the same command line, as well as names (IP addresses for
62 machines) and IDs. Precede the GID of each group with a hyphen to indicate
63 that it is negative.
64
65 =include fragments/pts-common.pod
66
67 =back
68
69 =head1 EXAMPLES
70
71 The following example deletes the user entries C<pat> and C<terry>:
72
73    % pts delete pat terry
74
75 The following example deletes the Protection Database entry of the group
76 with AFS GID -215.
77
78    % pts delete -215
79
80 =head1 PRIVILEGE REQUIRED
81
82 The issuer must belong to the system:administrators group to delete user
83 and machine entries. To delete group entries, the issuer must either own
84 the group or belong to the system:administrators group.
85
86 =head1 SEE ALSO
87
88 L<fs_cleanacl(1)>,
89 L<pts(1)>,
90 L<pts_removeuser(1)>
91
92 =head1 COPYRIGHT
93
94 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
95
96 This documentation is covered by the IBM Public License Version 1.0.  It was
97 converted from HTML to POD by software written by Chas Williams and Russ
98 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.