openafs/doc/man-pages/pod8/bos_adduser.pod
Ken Dreyer 1cc8feb6fc doc: replace hostnames with IETF example hostnames
There were several different real and made-up hostnames and company names used
throughout our documentation examples.

The IETF has reserved "example.com" and other "example" TLDs for use in
examples (RFC 2606). Replace almost all references to ABC Corporation, DEF
Corporation, and State University, as well as "abc.com", "bigcell.com",
"def.com", "def.gov", "ghi.com", "ghi.gov", "jkl.com", "mit.edu",
"stanford.edu", "state.edu", "stateu.edu", "uncc.edu", and "xyz.com".
Standardize on "Example Corporation", "Example Network", "Example
Organization" (example.com, example.net, and example.org).

The Scout documentation in the Admin Guide contains PNG images that contain
the old cell names, so I left those references until the images can be
replaced.

Change-Id: I4e44815b2d2ffe204810b7fd850842248f67c367
Reviewed-on: http://gerrit.openafs.org/6697
Reviewed-by: Jeffrey Altman <jaltman@secure-endpoints.com>
Tested-by: Jeffrey Altman <jaltman@secure-endpoints.com>
2012-02-17 20:51:58 -08:00

103 lines
3.0 KiB
Plaintext

=head1 NAME
bos_adduser - Adds a privileged user to the UserList file
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<bos adduser> S<<< B<-server> <I<machine name>> >>> S<<< B<-user> <I<user names>>+ >>>
S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
B<bos addu> S<<< B<-s> <I<machine name>> >>> S<<< B<-u> <I<user names>>+ >>>
S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-h>]
=for html
</div>
=head1 DESCRIPTION
The bos adduser command adds each user name specified with the B<-user>
argument to the F</usr/afs/etc/UserList> file on the machine named by the
B<-server> argument. It is the issuer's responsibility to verify that an
entry for the user exists in the Authentication and Protection Databases.
=head1 OPTIONS
=over 4
=item B<-server> <I<machine name>>
Indicates the server machine on which to change the
F</usr/afs/etc/UserList> file. Identify the machine by IP address or its
host name (either fully-qualified or abbreviated unambiguously). For
details, see L<bos(8)>.
In cells that use the Update Server to distribute the contents of the
F</usr/afs/etc> directory, it is conventional to specify only the system
control machine as a value for the B<-server> argument. Otherwise, repeat
the command for each file server machine. For further discussion, see
L<bos(8)>.
=item B<-user> <I<user names>>+
Specifies each user name to insert into the F</usr/afs/etc/UserList> file.
=item B<-cell> <I<cell name>>
Names the cell in which to run the command. Do not combine this argument
with the B<-localauth> flag. For more details, see L<bos(8)>.
=item B<-noauth>
Assigns the unprivileged identity C<anonymous> to the issuer. Do not
combine this flag with the B<-localauth> flag. For more details, see
L<bos(8)>.
=item B<-localauth>
Constructs a server ticket using a key from the local
F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
ticket to the BOS Server during mutual authentication. Do not combine this
flag with the B<-cell> or B<-noauth> options. For more details, see
L<bos(8)>.
=item B<-help>
Prints the online help for this command. All other valid options are
ignored.
=back
=head1 EXAMPLES
The following command adds the user names C<pat> and C<smith> to the
F</usr/afs/etc/UserList> file on the machine C<fs1.example.com> (the system
control machine).
% bos adduser -server fs1.example.com -user pat smith
=head1 PRIVILEGE REQUIRED
The issuer must be listed in the F</usr/afs/etc/UserList> file on the
machine named by the B<-server> argument, or must be logged onto a server
machine as the local superuser C<root> if the B<-localauth> flag is
included.
=head1 SEE ALSO
L<KeyFile(5)>,
L<UserList(5)>,
L<bos(8)>,
L<bos_listusers(8)>,
L<bos_removeuser(8)>
=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.