pod-man-pages-20051015
[openafs.git] / doc / man-pages / pod / bos_adduser.pod
1 =head1 NAME
2
3 bos adduser - Adds a privileged user to the B</usr/afs/etc/UserList> file
4
5 =head1 SYNOPSIS
6
7 bos adduser B<-server> I<machine name>  B<-user> I<user names> [I<user names> ...]
8 [B<-cell> I<cell name>]  [B<-noauth>]  [B<-localauth>]  [B<-help>]
9
10 bos addu B<-s> I<machine name>  B<-u> I<user names> [I<user names> ...]
11 [B<-c> I<cell name>]  [B<-n>]  [B<-l>]  [B<-h>]
12
13 =head1 DESCRIPTION
14
15 The C<bos adduser> command adds each user name specified with the B<-user>
16 argument to the B</usr/afs/etc/UserList> file on the machine named by the
17 B<-server> argument. It is the issuer's responsibility to verify that an
18 entry for the user exists in the Authentication and Protection
19 Databases.
20
21 =head1 OPTIONS
22
23 =over 4
24
25 =item B<-server> I<machine name>
26
27 Indicates the server machine on which to change the
28 B</usr/afs/etc/UserList> file. Identify the machine by IP address
29 or its host name (either fully-qualified or abbreviated
30 unambiguously). For details, see the introductory reference
31 page for the C<bos> command suite.
32
33 In cells that run the United States edition of AFS and use the
34 Update Server to distribute the contents of the B</usr/afs/etc>
35 directory, it is conventional to specify only the system
36 control machine as a value for the B<-server> argument. In cells
37 that run the international version of AFS, repeat the command
38 for each file server machine. For further discussion, see the
39 introductory reference page for the C<bos> command suite.
40
41 =item B<-user> I<user names> [I<user names> ...]
42
43 Specifies each user name to insert into the
44 B</usr/afs/etc/UserList> file.
45
46 =item B<-cell> I<cell name>
47
48 Names the cell in which to run the command. Do not combine this
49 argument with the B<-localauth> flag. For more details, see the
50 introductory L<bos(1)> reference page.
51
52 =item B<-noauth>
53
54 Assigns the unprivileged identity B<anonymous> to the issuer. Do
55 not combine this flag with the B<-localauth> flag. For more
56 details, see the introductory L<bos(1)> reference page.
57
58 =item B<-localauth>
59
60 Constructs a server ticket using a key from the local
61 B</usr/afs/etc/KeyFile> file. The C<bos> command interpreter presents
62 the ticket to the BOS Server during mutual authentication. Do
63 not combine this flag with the B<-cell> or B<-noauth> options. For
64 more details, see the introductory L<bos(1)> reference page.
65
66 =item B<-help>
67
68 Prints the online help for this command. All other valid
69 options are ignored.
70
71 =back
72
73 =head1 EXAMPLES
74
75 The following command adds the user names pat and smith to the
76 B</usr/afs/etc/UserList> file on the machine B<fs1.abc.com> (the system
77 control machine).
78
79     bos adduser -server fs1.abc.com -user pat smith
80
81 =head1 PRIVILEGE REQUIRED
82
83 The issuer must be listed in the B</usr/afs/etc/UserList> file on the
84 machine named by the B<-server> argument, or must be logged onto a server
85 machine as the local superuser B<root> if the B<-localauth> flag is
86 included.
87
88 =head1 COPYRIGHT
89
90 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
91
92 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
93 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
94 Stanford Linear Accelerator Center, a department of Stanford University.
95
96 =head1 SEE ALSO
97
98 L<KeyFile(1)>,
99 L<UserList(1)>,
100 L<bos(1)>,
101 L<bos_listusers(1)>,
102 L<bos_removeuser(1)>
103
104 =cut