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