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