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