man-page-fs-read-not-list-20080711
[openafs.git] / doc / man-pages / pod1 / pts_listowned.pod
1 =head1 NAME
2
3 pts_listowned - Show the Protection Database groups owned by a user or group
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<pts listowned> S<<< B<-nameorid> <I<user or group name or id>>+ >>>
11     [-cell <I<cell name>>] [B<-noauth>] [B<-localauth>] [B<-force>] [B<-help>]
12
13 B<pts listo> S<<< B<-na> <I<user or group name or id>>+ >>>
14     [-c <I<cell name>>] [B<-no>] [B<-l>] [B<-f>] [B<-h>]
15
16 =for html
17 </div>
18
19 =head1 DESCRIPTION
20
21 The B<pts listowned> command lists the groups owned by each user or group
22 specified by the B<-nameorid> argument.
23
24 To list any I<orphaned group>s, whose owners have themselves been deleted
25 from the Protection Database, provide a value of C<0> (zero) for the
26 B<-nameorid> argument. To change the owner to a user or group that still
27 exists, use the B<pts chown> command.
28
29 =head1 OPTIONS
30
31 =over 4
32
33 =item B<-nameorid> <I<user or group name or id>>+
34
35 Specifies the name or AFS UID of each user, or the name or AFS GID of each
36 group, for which to display the list of owned groups. It is acceptable to
37 mix users and groups on the same command line, as well as names and
38 IDs. Precede the GID of each group with a hyphen to indicate that it is
39 negative.
40
41 A value of 0 (zero) lists group entries for groups whose owners no longer
42 have entries in the Protection Database.
43
44 =item B<-cell> <I<cell name>>
45
46 Names the cell in which to run the command. For more details, see
47 L<pts(1)>.
48
49 =item B<-noauth>
50
51 Assigns the unprivileged identity anonymous to the issuer. For more
52 details, see L<pts(1)>.
53
54 =item B<-localauth>
55
56 Constructs a server ticket using a key from the local
57 F</usr/afs/etc/KeyFile> file. Do not combine this flag with the 
58 B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
59
60 =item B<-force>
61
62 Enables the command to continue executing as far as possible when errors
63 or other problems occur, rather than halting execution at the first error.
64
65 =item B<-help>
66
67 Prints the online help for this command. All other valid options are
68 ignored.
69
70 =back
71
72 =head1 OUTPUT
73
74 The first line of the output indicates the name and AFS UID or AFS GID of
75 each user or group for which ownership information is requested, in the
76 following format:
77
78    Groups owned by <name> (id: <ID>) are:
79
80 A list of groups follows. The list does not include groups owned by groups
81 that the user or group owns, or to which the user or group belongs. If the
82 user or group does not own any groups, only the header line appears.
83
84 The following error message appears if the issuer is not privileged to
85 view ownership information. By default, for both user and group entries
86 the second privacy flag is the hyphen, which denies permission to anyone
87 other than the user (for a user entry) and the members of the
88 system:administrators group.
89
90    pts: Permission denied so failed to get owner list for <name> (id: <ID>)
91
92 =head1 EXAMPLES
93
94 The following example lists the groups owned by user terry and shows that
95 the group C<terry:friends> does not own any groups:
96
97    % pts listowned terry terry:friends
98    Groups owned by terry (id: 1045) are:
99      terry:friends
100      terry:project1
101      terry:project2
102    Groups owned by terry:friends (id: -673) are:
103
104 =head1 PRIVILEGE REQUIRED
105
106 The required privilege depends on the setting of the second privacy flag
107 in the Protection Database entry of each user or group indicated by the
108 B<-nameorid> argument (use the B<pts examine> command to display the
109 flags):
110
111 =over 4
112
113 =item *
114
115 If it is the hyphen and the B<-nameorid> argument specifies a group, only
116 the members of the system:administrators group and the owner of a group
117 can list the groups it owns.
118
119 =item *
120
121 If it is the hyphen and the B<-nameorid> argument specifies a user, only
122 the members of the system:administrators group and the associated user can
123 list the groups he or she owns.
124
125 =item *
126
127 If it is uppercase letter C<O>, anyone who can access the cell's database
128 server machines can list the groups owned by this user or group.
129
130 =back
131
132 =head1 SEE ALSO
133
134 L<pts(1)>,
135 L<pts_chown(1)>,
136 L<pts_examine(1)>,
137 L<pts_setfields(1)>
138
139 =head1 COPYRIGHT
140
141 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
142
143 This documentation is covered by the IBM Public License Version 1.0.  It was
144 converted from HTML to POD by software written by Chas Williams and Russ
145 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.