Document KeyFileExt(5)
[openafs.git] / doc / man-pages / pod8 / bos_adduser.pod
1 =head1 NAME
2
3 bos_adduser - Adds a privileged user to the UserList file
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<bos adduser> S<<< B<-server> <I<machine name>> >>> S<<< B<-user> <I<user names>>+ >>>
11     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
12
13 B<bos addu> S<<< B<-s> <I<machine name>> >>> S<<< B<-u> <I<user names>>+ >>>
14     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-h>]
15
16 =for html
17 </div>
18
19 =head1 DESCRIPTION
20
21 The bos adduser command adds each user name specified with the B<-user>
22 argument to the F</usr/afs/etc/UserList> file on the machine named by the
23 B<-server> argument. It is the issuer's responsibility to verify that an
24 entry for the user exists in the Authentication and Protection Databases.
25
26 =head1 OPTIONS
27
28 =over 4
29
30 =item B<-server> <I<machine name>>
31
32 Indicates the server machine on which to change the
33 F</usr/afs/etc/UserList> file. Identify the machine by IP address or its
34 host name (either fully-qualified or abbreviated unambiguously). For
35 details, see L<bos(8)>.
36
37 In cells that use the Update Server to distribute the contents of the
38 F</usr/afs/etc> directory, it is conventional to specify only the system
39 control machine as a value for the B<-server> argument. Otherwise, repeat
40 the command for each file server machine. For further discussion, see
41 L<bos(8)>.
42
43 =item B<-user> <I<user names>>+
44
45 Specifies each user name to insert into the F</usr/afs/etc/UserList> file.
46
47 =item B<-cell> <I<cell name>>
48
49 Names the cell in which to run the command. Do not combine this argument
50 with the B<-localauth> flag. For more details, see L<bos(8)>.
51
52 =item B<-noauth>
53
54 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
55 combine this flag with the B<-localauth> flag. For more details, see
56 L<bos(8)>.
57
58 =item B<-localauth>
59
60 Constructs a server ticket using a key from the local
61 F</usr/afs/etc/KeyFile> or F</usr/afs/etc/KeyFileExt> file.
62 The B<bos> command interpreter presents the
63 ticket to the BOS Server during mutual authentication. Do not combine this
64 flag with the B<-cell> or B<-noauth> options. For more details, see
65 L<bos(8)>.
66
67 =item B<-help>
68
69 Prints the online help for this command. All other valid options are
70 ignored.
71
72 =back
73
74 =head1 EXAMPLES
75
76 The following command adds the user names C<pat> and C<smith> to the
77 F</usr/afs/etc/UserList> file on the machine C<fs1.example.com> (the system
78 control machine).
79
80    % bos adduser -server fs1.example.com -user pat smith
81
82 =head1 PRIVILEGE REQUIRED
83
84 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
85 machine named by the B<-server> argument, or must be logged onto a server
86 machine as the local superuser C<root> if the B<-localauth> flag is
87 included.
88
89 =head1 SEE ALSO
90
91 L<KeyFile(5)>,
92 L<KeyFileExt(5)>,
93 L<UserList(5)>,
94 L<bos(8)>,
95 L<bos_listusers(8)>,
96 L<bos_removeuser(8)>
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.