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