doc/man-pages/pod1/pts_removeuser.pod.in

   1 =head1 NAME
   2
   3 pts_removeuser - Removes a user from a Protection Database group
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<pts removeuser> S<<< B<-user> <I<user name>>+ >>> S<<< B<-group> <I<group name>>+ >>>
  11     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-force>]
  12     [B<-help>]
  13
  14 B<pts rem> S<<< B<-u> <I<user name>>+ >>> S<<< B<-g> <I<group name>>+ >>>
  15     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>]
  16
  17 =for html
  18 </div>
  19
  20 =head1 DESCRIPTION
  21
  22 The B<pts removeuser> command removes each user or machine named by the
  23 B<-user> argument from each group named by the B<-group> argument.
  24
  25 To add users to a group, use the B<pts adduser> command. To list group
  26 membership, use the B<pts membership> command. To remove users from a
  27 group and delete the group's entry completely in a single step, use the
  28 B<pts delete> command.
  29
  30 =head1 CAUTIONS
  31
  32 AFS compiles each user's group membership as he or she authenticates. Any
  33 users who have valid tokens when they are removed from a group retain the
  34 privileges extended to that group's members until they discard their
  35 tokens or reauthenticate.
  36
  37 =head1 OPTIONS
  38
  39 =over 4
  40
  41 =item B<-name> <I<user name>>+
  42
  43 Specifies the name of each user entry or the IP address (complete or
  44 wildcard-style) of each machine entry to remove.
  45
  46 =item B<-group> <I<group name>>+
  47
  48 Names each group from which to remove members.
  49
  50 =include fragments/pts-common.pod
  51
  52 =back
  53
  54 =head1 EXAMPLES
  55
  56 The following example removes user smith from the groups C<staff> and
  57 C<staff:finance>. Note that no switch names are necessary because only a
  58 single instance is provided for the first argument (the username).
  59
  60    % pts removeuser smith staff staff:finance
  61
  62 The following example removes three machine entries, which represent all
  63 machines in the Example Corporation network, from the group C<bin-prot>:
  64
  65    % pts removeuser -user 138.255.0.0 192.12.105.0 192.12.106.0 -group bin-prot
  66
  67 =head1 PRIVILEGE REQUIRED
  68
  69 The required privilege depends on the setting of the fifth privacy flag in
  70 the Protection Database for the group named by the B<-group> argument (use
  71 the B<pts examine> command to display the flags):
  72
  73 =over 4
  74
  75 =item *
  76
  77 If it is the hyphen, only the group's owner and members of the
  78 system:administrators group can remove members.
  79
  80 =item *
  81
  82 If it is lowercase C<r>, members of the group can also remove other
  83 members.
  84
  85 =back
  86
  87 (It is not possible to set the fifth flag to uppercase C<R>.)
  88
  89 =head1 SEE ALSO
  90
  91 L<pts(1)>,
  92 L<pts_adduser(1)>,
  93 L<pts_examine(1)>,
  94 L<pts_membership(1)>,
  95 L<pts_setfields(1)>
  96
  97 =head1 COPYRIGHT
  98
  99 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 100
 101 This documentation is covered by the IBM Public License Version 1.0.  It was
 102 converted from HTML to POD by software written by Chas Williams and Russ
 103 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.