Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod8 / bos_listusers.pod
CommitLineData
805e021f
CE
1=head1 NAME
2
3bos_listusers - Lists the privileged users from the UserList file
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<bos listusers> S<<< B<-server> <I<machine name>> >>> S<<< [B<-cell> <I<cell name>>] >>>
11 [B<-noauth>] [B<-localauth>] [B<-help>]
12
13B<bos listu> S<<< B<-s> <I<machine name>> >>> S<<< [B<-c> <I<cell name>>] >>> [B<-n>]
14 [B<-l>] [B<-h>]
15
16=for html
17</div>
18
19=head1 DESCRIPTION
20
21The B<bos listusers> command lists the user names from the
22F</usr/afs/etc/UserList> file on the file server machine named by the
23B<-server> argument. The users are authorized to issue privileged B<bos>
24and B<vos> commands.
25
26To edit the list of users, use the B<bos adduser> and B<bos removeuser>
27commands.
28
29=head1 OPTIONS
30
31=over 4
32
33=item B<-server> <I<machine name>>
34
35Indicates the server machine from which to display the UserList
36file. Identify the machine by IP address or its host name (either
37fully-qualified or abbreviated unambiguously). For details, see L<bos(8)>.
38
39For consistent performance in the cell, the output must be the same on
40every server machine. The B<bos adduser> reference page explains how to
41keep the machines synchronized.
42
43=item B<-cell> <I<cell name>>
44
45Names the cell in which to run the command. Do not combine this argument
46with the B<-localauth> flag. For more details, see L<bos(8)>.
47
48=item B<-noauth>
49
50Assigns the unprivileged identity C<anonymous> to the issuer. Do not
51combine this flag with the B<-localauth> flag. For more details, see
52L<bos(8)>.
53
54=item B<-localauth>
55
56Constructs a server ticket using a key from the local
57F</usr/afs/etc/KeyFile> or F</usr/afs/etc/KeyFileExt> file.
58The B<bos> command interpreter presents the
59ticket to the BOS Server during mutual authentication. Do not combine this
60flag with the B<-cell> or B<-noauth> options. For more details, see
61L<bos(8)>.
62
63=item B<-help>
64
65Prints the online help for this command. All other valid options are
66ignored.
67
68=back
69
70=head1 OUTPUT
71
72The output lists the user name of each user entitled to issue privileged
73B<bos> and B<vos> commands.
74
75=head1 EXAMPLES
76
77The following example lists the users from UserList file on the machine
78C<fs4.example.com>.
79
80 % bos listusers fs4.example.com
81 SUsers are: pat smith jones terry
82
83=head1 PRIVILEGE REQUIRED
84
85None
86
87=head1 SEE ALSO
88
89L<KeyFile(5)>,
90L<KeyFileExt(5)>,
91L<UserList(5)>,
92L<bos(8)>,
93L<bos_adduser(8)>,
94L<bos_removeuser(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.