doc: refer to aklog instead of klog
[openafs.git] / doc / man-pages / pod1 / pts_adduser.pod.in
1 =head1 NAME
2
3 pts_adduser - Adds a user or machine to a Protection Database group
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<pts adduser> 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>] [B<-help>]
12
13 B<pts ad> S<<< B<-u> <I<user name>>+ >>> S<<< B<-g> <I<group name>>+ >>>
14     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>]
15
16 =for html
17 </div>
18
19 =head1 DESCRIPTION
20
21 The B<pts adduser> command adds each user or machine entry named by the
22 B<-user> argument as a member of each group named by the B<-group>
23 argument.
24
25 To remove members of a group, use the B<pts removeuser> command. To list
26 the groups to which a user or machine belongs, or the members of a
27 specified group, use the B<pts membership> command.
28
29 =head1 CAUTIONS
30
31 After being added as a group member, a currently authenticated user must
32 reauthenticate (for example, by issuing the B<aklog> or B<klog.krb5> commands)
33 to obtain permissions granted to the group on an access control list (ACL).
34
35 =head1 OPTIONS
36
37 =over 4
38
39 =item B<-user> <I<user name>>+
40
41 Specifies the name of each user or machine entry to add to each group
42 named by the B<-group> argument. The name of a machine entry resembles an
43 IP address and can use the wildcard notation described on the B<pts
44 createuser> reference page. The user or machine entry must already exist
45 in the Protection Database.
46
47 =item B<-group> <I<group name>>+
48
49 Specifies the complete name (including the owner prefix if applicable) of
50 each group to which to add members. The group entry must already exist in
51 the Protection Database.
52
53 =include fragments/pts-common.pod
54
55 =back
56
57 =head1 EXAMPLES
58
59 The following example adds user smith to the group system:administrators.
60
61    % pts adduser -user smith -group system:administrators
62
63 The following example adds users C<jones>, C<terry>, and B<pat> to the
64 smith:colleagues group.
65
66    % pts adduser -user jones terry pat -group smith:colleagues
67
68 The following example adds the machine entries in the ABC Corporation
69 subnet to the group C<bin-prot>. Because of the IP address range of the
70 ABC Corporation subnet, the system administrator was able to group the
71 machines into three machine entries (using the wildcard notation discussed
72 on the B<pts createuser> reference page).
73
74    % pts adduser -user 138.255.0.0 192.12.105.0 192.12.106.0 -group bin-prot
75
76 =head1 PRIVILEGE REQUIRED
77
78 The required privilege depends on the setting of the fourth privacy flag
79 in the Protection Database entry for each group named by the B<-group>
80 argument (use the B<pts examine> command to display the flags):
81
82 =over 4
83
84 =item *
85
86 If it is the hyphen, only the group's owner and members of the
87 system:administrators group can add members.
88
89 =item *
90
91 If it is lowercase C<a>, current members of the group can add new members.
92
93 =item *
94
95 If it is uppercase C<A>, anyone who can access the cell's database server
96 machines can add new members.
97
98 =back
99
100 =head1 SEE ALSO
101
102 L<pts(1)>,
103 L<pts_createuser(1)>,
104 L<pts_examine(1)>,
105 L<pts_membership(1)>,
106 L<pts_removeuser(1)>,
107 L<pts_setfields(1)>
108
109 =head1 COPYRIGHT
110
111 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
112
113 This documentation is covered by the IBM Public License Version 1.0.  It was
114 converted from HTML to POD by software written by Chas Williams and Russ
115 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.