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 B<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 Members of the system:ptsviewers and system:administrators groups can
 116 always use this command in any of its variations.  Additionally, a user
 117 can always list the groups to which they belong, and the owner of a group
 118 can always list the members of the group.
 119
 120 Additional privileges may be granted by the setting of the third privacy
 121 flag in the Protection Database entry of each user or group indicated by
 122 the B<-nameorid> argument (use the B<pts examine> command to display the
 123 flags):
 124
 125 =over 4
 126
 127 =item *
 128
 129 If it is a hyphen, the default permissions described above apply.
 130
 131 =item *
 132
 133 If it is lowercase C<m> and the B<-nameorid> argument specifies a group,
 134 then members of that group can also list the other members.  A privacy
 135 flag of C<m> only changes the permissions when set for a group.  Setting
 136 this flag for a user or a machine has no effect.
 137
 138 =item *
 139
 140 If it is uppercase C<M>, anyone who can access the cell's database server
 141 machines can list the membership of the group or the groups to which that
 142 user or machine belongs, depending on what type of entry the flag is set
 143 on.
 144
 145 =back
 146
 147 =head1 SEE ALSO
 148
 149 L<pts(1)>,
 150 L<pts_adduser(1)>,
 151 L<pts_examine(1)>,
 152 L<pts_removeuser(1)>,
 153 L<pts_setfields(1)>
 154
 155 =head1 COPYRIGHT
 156
 157 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 158
 159 This documentation is covered by the IBM Public License Version 1.0.  It was
 160 converted from HTML to POD by software written by Chas Williams and Russ
 161 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.