openafs/doc/man-pages/pod1/pts_removeuser.pod.in
Andrew Deason f69bf0b194 doc: pts manpage fixes
- Mention the -help, -auth, -encrypt, and -config options for all pts
   commands in their synopsis

 - Add the -auth option to the pts.pod page

 - Reference the -auth, -encrypt, and -config options from all
   subcommand pts pages

 - pts_removeuser: Replace -name with -user

 - pts_sleep: Add missing -delay

 - pts_source: Add missing -file

Change-Id: I4f0889d661c46f6bdd2a9604d8423d809a632d2d
Reviewed-on: http://gerrit.openafs.org/10387
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Derrick Brashear <shadow@your-file-system.com>
2013-11-03 20:36:16 -08:00

105 lines
2.9 KiB
Plaintext

=head1 NAME
pts_removeuser - Removes a user from a Protection Database group
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<pts removeuser> S<<< B<-user> <I<user name>>+ >>> S<<< B<-group> <I<group name>>+ >>>
S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-force>]
[B<-help>] [B<-auth>] [B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
B<pts rem> S<<< B<-u> <I<user name>>+ >>> S<<< B<-g> <I<group name>>+ >>>
S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>]
[B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
=for html
</div>
=head1 DESCRIPTION
The B<pts removeuser> command removes each user or machine named by the
B<-user> argument from each group named by the B<-group> argument.
To add users to a group, use the B<pts adduser> command. To list group
membership, use the B<pts membership> command. To remove users from a
group and delete the group's entry completely in a single step, use the
B<pts delete> command.
=head1 CAUTIONS
AFS compiles each user's group membership as he or she authenticates. Any
users who have valid tokens when they are removed from a group retain the
privileges extended to that group's members until they discard their
tokens or reauthenticate.
=head1 OPTIONS
=over 4
=item B<-user> <I<user name>>+
Specifies the name of each user entry or the IP address (complete or
wildcard-style) of each machine entry to remove.
=item B<-group> <I<group name>>+
Names each group from which to remove members.
=include fragments/pts-common.pod
=back
=head1 EXAMPLES
The following example removes user smith from the groups C<staff> and
C<staff:finance>. Note that no switch names are necessary because only a
single instance is provided for the first argument (the username).
% pts removeuser smith staff staff:finance
The following example removes three machine entries, which represent all
machines in the Example Corporation network, from the group C<bin-prot>:
% pts removeuser -user 138.255.0.0 192.12.105.0 192.12.106.0 -group bin-prot
=head1 PRIVILEGE REQUIRED
The required privilege depends on the setting of the fifth privacy flag in
the Protection Database for the group named by the B<-group> argument (use
the B<pts examine> command to display the flags):
=over 4
=item *
If it is the hyphen, only the group's owner and members of the
system:administrators group can remove members.
=item *
If it is lowercase C<r>, members of the group can also remove other
members.
=back
(It is not possible to set the fifth flag to uppercase C<R>.)
=head1 SEE ALSO
L<pts(1)>,
L<pts_adduser(1)>,
L<pts_examine(1)>,
L<pts_membership(1)>,
L<pts_setfields(1)>
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
This documentation is covered by the IBM Public License Version 1.0. It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.