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