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