d6680fe0f0cc42247231b222f9673bcd607ea644
[openafs.git] / doc / man-pages / pod1 / pts_membership.pod
1 =head1 NAME
2
3 pts_membership - Displays the membership list for a user or group
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<pts membership> S<<< B<-nameorid> <I<user or group name or id>>+ >>>
11     [B<-supergroups>]
12     S<<< [B<-cell> <I<cell name>>] >>> [B<-localauth>] [B<-noauth>] 
13     [B<-force>] [B<-help>]
14
15 B<pts m> S<<< B<-na> <I<user or group name or id>>+ >>>
16     [B<-s>] S<<< [B<-c> <I<cell name>>] >>>
17     [B<-no>] [B<-l>] [B<-f>] [B<-h>]
18
19 B<pts groups> S<<< B<-na> <I<user or group name or id>>+ >>>
20     [B<-s>] S<<< [B<-c> <I<cell name>>] >>>
21     [B<-no>] [B<-l>] [B<-f>] [B<-h>]
22
23 B<pts g> S<<< B<-na> <I<user or group name or id>>+ >>>
24     [B<-s>] S<<< [B<-c> <I<cell name>>] >>>
25     [B<-no>] [B<-l>] [B<-f>] [B<-h>]
26
27 =for html
28 </div>
29
30 =head1 DESCRIPTION
31
32 The B<pts membership> command lists the groups to which each user or
33 machine specified by the B<-nameorid> argument belongs, or lists the users
34 and machines that belong to each group specified by the B<-nameorid>
35 argument.
36
37 It is not possible to list the members of the system:anyuser or
38 system:authuser groups, and they do not appear in the list of groups to
39 which a user belongs.
40
41 To add users or machine to groups, use the B<pts adduser> command; to remove
42 them, use the B<pts removeuser> command.
43
44 =head1 OPTIONS
45
46 =over 4
47
48 =item B<-nameorid> <I<user or group name or id>>+
49
50 Specifies the name or AFS UID of each user entry, the IP address (complete
51 or wildcard-style) or AFS UID of each machine entry, or the name or AFS
52 GID of each group, for which to list group membership. It is acceptable to
53 mix users, machines, and groups on the same command line, as well as names
54 and IDs. Precede the GID of each group with a hyphen to indicate that it
55 is negative.
56
57 =item B<-supergroups>
58
59 List the groups to which each group specified by the B<-nameorid>
60 argument belongs, in addition to user and machine members. Group
61 membership may be nested when B<ptserver> is compilied with the
62 SUPERGROUPS option enabled.
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<-localauth>
75
76 Constructs a server ticket using a key from the local
77 F</usr/afs/etc/KeyFile> file. Do not combine this flag with the 
78 B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
79
80 =item B<-force>
81
82 Enables the command to continue executing as far as possible when errors
83 or other problems occur, rather than halting execution at the first error.
84
85 =item B<-help>
86
87 Prints the online help for this command. All other valid options are
88 ignored.
89
90 =back
91
92 =head1 OUTPUT
93
94 For each user and machine, the output begins with the following header
95 line, followed by a list of the groups to which the user or machine
96 belongs:
97
98    Groups <name> (id: <AFS UID>) is a member of:
99
100 For each group, the output begins with the following header line, followed
101 by a list of the users and machines who belong to the group:
102
103    Members of <group_name> (id: <AFS GID>) are:
104
105 =head1 EXAMPLES
106
107 The following example lists the groups to which the user C<pat> belongs
108 and the members of the group C<smith:friends>.  Note that third privacy
109 flag for the C<pat> entry was changed from the default hyphen to enable a
110 non-administrative user to obtain this listing.
111
112    % pts membership pat smith:friends
113    Groups pat (id: 1144) is a member of:
114      smith:friends
115      staff
116      johnson:project-team
117    Members of smith:friends (id: -562) are:
118      pat
119      terry
120      jones
121      richard
122      thompson
123
124 =head1 PRIVILEGE REQUIRED
125
126 Members of the system:ptsviewers and system:administrators groups can
127 always use this command in any of its variations.  Additionally, a user
128 can always list the groups to which they belong, and the owner of a group
129 can always list the members of the group.
130
131 Additional privileges may be granted by the setting of the third privacy
132 flag in the Protection Database entry of each user or group indicated by
133 the B<-nameorid> argument (use the B<pts examine> command to display the
134 flags):
135
136 =over 4
137
138 =item *
139
140 If it is a hyphen, the default permissions described above apply.
141
142 =item *
143
144 If it is lowercase C<m> and the B<-nameorid> argument specifies a group,
145 then members of that group can also list the other members.  A privacy
146 flag of C<m> only changes the permissions when set for a group.  Setting
147 this flag for a user or a machine has no effect.
148
149 =item *
150
151 If it is uppercase C<M>, anyone who can access the cell's database server
152 machines can list the membership of the group or the groups to which that
153 user or machine belongs, depending on what type of entry the flag is set
154 on.
155
156 =back
157
158 =head1 SEE ALSO
159
160 L<pts(1)>,
161 L<pts_adduser(1)>,
162 L<pts_examine(1)>,
163 L<pts_removeuser(1)>,
164 L<pts_setfields(1)>
165
166 =head1 COPYRIGHT
167
168 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
169
170 This documentation is covered by the IBM Public License Version 1.0.  It was
171 converted from HTML to POD by software written by Chas Williams and Russ
172 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.