Add include method for POD documentation
[openafs.git] / doc / man-pages / pod1 / pts_listowned.pod.in
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 =include fragments/pts-common.pod
45
46 =back
47
48 =head1 OUTPUT
49
50 The first line of the output indicates the name and AFS UID or AFS GID of
51 each user or group for which ownership information is requested, in the
52 following format:
53
54    Groups owned by <name> (id: <ID>) are:
55
56 A list of groups follows. The list does not include groups owned by groups
57 that the user or group owns, or to which the user or group belongs. If the
58 user or group does not own any groups, only the header line appears.
59
60 The following error message appears if the issuer is not privileged to
61 view ownership information. By default, for both user and group entries
62 the second privacy flag is the hyphen, which denies permission to anyone
63 other than the user (for a user entry) and the members of the
64 system:administrators group.
65
66    pts: Permission denied so failed to get owner list for <name> (id: <ID>)
67
68 =head1 EXAMPLES
69
70 The following example lists the groups owned by user terry and shows that
71 the group C<terry:friends> does not own any groups:
72
73    % pts listowned terry terry:friends
74    Groups owned by terry (id: 1045) are:
75      terry:friends
76      terry:project1
77      terry:project2
78    Groups owned by terry:friends (id: -673) are:
79
80 =head1 PRIVILEGE REQUIRED
81
82 The required privilege depends on the setting of the second privacy flag
83 in the Protection Database entry of each user or group indicated by the
84 B<-nameorid> argument (use the B<pts examine> command to display the
85 flags):
86
87 =over 4
88
89 =item *
90
91 If it is the hyphen and the B<-nameorid> argument specifies a group, only
92 the members of the system:administrators group and the owner of a group
93 can list the groups it owns.
94
95 =item *
96
97 If it is the hyphen and the B<-nameorid> argument specifies a user, only
98 the members of the system:administrators group and the associated user can
99 list the groups he or she owns.
100
101 =item *
102
103 If it is uppercase letter C<O>, anyone who can access the cell's database
104 server machines can list the groups owned by this user or group.
105
106 =back
107
108 =head1 SEE ALSO
109
110 L<pts(1)>,
111 L<pts_chown(1)>,
112 L<pts_examine(1)>,
113 L<pts_setfields(1)>
114
115 =head1 COPYRIGHT
116
117 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
118
119 This documentation is covered by the IBM Public License Version 1.0.  It was
120 converted from HTML to POD by software written by Chas Williams and Russ
121 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.