doc/man-pages/pod1/pts_removeuser.pod

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