Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod8 / bos_removeuser.pod
CommitLineData
805e021f
CE
1=head1 NAME
2
3bos_removeuser - Removes a privileged user from the UserList file
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<bos removeuser> 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
13B<bos removeu> 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
21The B<bos removeuser> command removes each user name specified with the
22B<-user> argument from the F</usr/afs/etc/UserList> file on the machine
23named by the B<-server> argument.
24
25=head1 OPTIONS
26
27=over 4
28
29=item B<-server> <I<machine name>>
30
31Indicates the server machine on which to change the
32F</usr/afs/etc/UserList> file. Identify the machine by IP address or its
33host name (either fully-qualified or abbreviated unambiguously). For
34details, see L<bos(8)>.
35
36In cells that use the Update Server to distribute the contents of the
37F</usr/afs/etc> directory, it is conventional to specify only the system
38control machine as a value for the B<-server> argument. Otherwise, repeat
39the command for each file server machine. For further discussion, see
40L<bos(8)>.
41
42=item B<-user> <I<user names>>+
43
44Specifies each user name to remove.
45
46=item B<-cell> <I<cell name>>
47
48Names the cell in which to run the command. Do not combine this argument
49with the B<-localauth> flag. For more details, see L<bos(8)>.
50
51=item B<-noauth>
52
53Assigns the unprivileged identity C<anonymous> to the issuer. Do not
54combine this flag with the B<-localauth> flag. For more details, see
55L<bos(8)>.
56
57=item B<-localauth>
58
59Constructs a server ticket using a key from the local
60F</usr/afs/etc/KeyFile> or F</usr/afs/etc/KeyFileExt> file.
61The B<bos> command interpreter presents the
62ticket to the BOS Server during mutual authentication. Do not combine this
63flag with the B<-cell> or B<-noauth> options. For more details, see
64L<bos(8)>.
65
66=item B<-help>
67
68Prints the online help for this command. All other valid options are
69ignored.
70
71=back
72
73=head1 EXAMPLES
74
75The following example removes the users C<pat> and C<jones> from the
76F<UserList> file on the system control machine C<fs1.example.com>.
77
78 % bos removeuser -server fs1.example.com -user pat jones
79
80=head1 PRIVILEGE REQUIRED
81
82The issuer must be listed in the F</usr/afs/etc/UserList> file on the
83machine named by the B<-server> argument, or must be logged onto a server
84machine as the local superuser C<root> if the B<-localauth> flag is
85included.
86
87=head1 SEE ALSO
88
89L<KeyFile(5)>,
90L<KeyFileExt(5)>,
91L<UserList(5)>,
92L<bos(8)>,
93L<bos_addkey(8)>,
94L<bos_listkeys(8)>
95
96=head1 COPYRIGHT
97
98IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
99
100This documentation is covered by the IBM Public License Version 1.0. It was
101converted from HTML to POD by software written by Chas Williams and Russ
102Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.