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