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