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