openafs/doc/man-pages/pod1/pts_adduser.pod
Russ Allbery e3dfba8e6c man-page-conversion-20051208
This is the initial conversion of the AFS Adminstrators Reference into POD
for use as man pages.  The man pages are now generated via pod2man from
regen.sh so that only those working from CVS have to have pod2man
available.  The Makefile only installs.  The pages have also been sorted
out into pod1, pod5, and pod8 directories, making conversion to the right
section of man page easier without maintaining a separate list and allowing
for names to be duplicated between pod5 and pod1 or pod8 (which will likely
be needed in a few cases).

This reconversion is done with a new script based on work by Chas Williams.
In some cases, the output is worse than the previous POD pages, but this is
a more comprehensive conversion.

This is only the first step, and this initial conversion has various
problems.  In addition, the file man pages that didn't have simple names
have not been converted in this pass and will be added later.  Some of the
man pages have syntax problems and all of them have formatting errors.  The
next editing pass, coming shortly, will clean up most of the remaining
mess.
2005-12-08 12:14:33 +00:00

135 lines
3.6 KiB
Plaintext

=head1 NAME
pts adduser - Adds a user or machine to a Protection Database group
=head1 SYNOPSIS
B<pts adduser -user> <I<user name>>+ -group <I<group name>>+
[B<-cell> <I<cell name>>] [B<-noauth>] [B<-force>] [B<-help>]
B<pts ad -u> <I<user name>>+ B<-g> <I<group name>>+ [B<-c> <I<cell name>>] [B<-n>] [B<-f>] [-h]
=head1 DESCRIPTION
The pts adduser command adds each user or machine entry named by
the B<-user> argument as a member of each group named by the
B<-group> argument.
To remove members of a group, use the pts removeuser
command. To list the groups to which a user or machine belongs, or the
members of a specified group, use the B<pts membership>
command.
=head1 CAVEATS
After being added as a group member, a currently authenticated user must
reauthenticate (for example, by issuing the B<klog> command) to obtain
permissions granted to the group on an access control list (ACL).
=head1 OPTIONS
=over 4
=item -user
Specifies the name of each user or machine entry to add to each group
named by the B<-group> argument. The name of a machine entry
resembles an IP address and can use the wildcard notation described on the
B<pts createuser> reference page. The user or machine entry
must already exist in the Protection Database.
=item -group
Specifies the complete name (including the owner prefix if applicable) of
each group to which to add members. The group entry must already exist
in the Protection Database.
=item -cell
Names the cell in which to run the command. For more details, see
the introductory B<pts> reference page.
=item -noauth
Assigns the unprivileged identity anonymous to the
issuer. For more details, see the introductory B<pts> reference
page.
=item -force
Enables the command to continue executing as far as possible when errors
or other problems occur, rather than halting execution at the first
error.
=item -help
Prints the online help for this command. All other valid options
are ignored.
=back
=head1 EXAMPLES
The following example adds user smith to the group
B<system:administrators>.
% pts adduser -user smith -group system:administrators
The following example adds users B<jones>, terry, and
B<pat> to the B<smith:colleagues> group.
% pts adduser -user jones terry pat -group smith:colleagues
The following example adds the machine entries in the ABC Corporation
subnet to the group B<bin-prot>. Because of the IP address
range of the ABC Corporation subnet, the system administrator was able to
group the machines into three machine entries (using the wildcard notation
discussed on the B<pts createuser> reference page).
% pts adduser -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 fourth privacy flag in
the Protection Database entry for each 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
B<system:administrators> group can add members.
=item *
If it is lowercase C<a>, current members of the group can add new
members.
=item *
If it is uppercase C<A>, anyone who can access the cell's
database server machines can add new members.
=back
=head1 SEE ALSO
L<pts(1)>,
L<pts_createuser(1)>,
L<pts_examine(1)>,
L<pts_membership(1)>,
L<pts_removeuser(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.