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