man-page-reorg-20051209
[openafs.git] / doc / man-pages / pod8 / bos_listusers.pod
1 =head1 NAME
2
3 bos listusers - Lists the privileged users from the /usr/afs/etc/UserList file
4
5 =head1 SYNOPSIS
6
7 B<bos listusers -server> <I<machine name>>  [-cell <I<cell name>>]  
8 [B<-noauth>]   [B<-localauth>]   [B<-help>]
9
10 B<bos listu -s> <I<machine name>>  [B<-c> <I<cell name>>]  [B<-n>]  [B<-l>]  [-h]
11
12 =head1 DESCRIPTION
13
14 The bos listusers command lists the user names from the
15 B</usr/afs/etc/UserList> file on the file server machine named by the
16 B<-server> argument. The users are authorized to issue
17 privileged B<bos> and B<vos> commands.
18
19 To edit the list of users, use the B<bos adduser> and bos
20 removeuser commands.
21
22 =head1 OPTIONS
23
24 =over 4
25
26 =item -server
27 >
28
29 Indicates the server machine from which to display the UserList
30 file. Identify the machine by IP address or its host name (either
31 fully-qualified or abbreviated unambiguously). For details, see the
32 introductory reference page for the B<bos> command suite. 
33
34 For consistent performance in the cell, the output must be the same on
35 every server machine. The B<bos adduser> reference page
36 explains how to keep the machines synchronized.
37
38 =item -cell
39 >
40
41 Names the cell in which to run the command. Do not combine this
42 argument with the B<-localauth> flag. For more details, see the
43 introductory B<bos> reference page.
44
45 =item -noauth
46 >
47
48 Assigns the unprivileged identity anonymous to the
49 issuer. Do not combine this flag with the B<-localauth>
50 flag. For more details, see the introductory B<bos> reference
51 page.
52
53 =item -localauth
54 >
55
56 Constructs a server ticket using a key from the local
57 B</usr/afs/etc/KeyFile> file. The B<bos> command
58 interpreter presents the ticket to the BOS Server during mutual
59 authentication. Do not combine this flag with the B<-cell> or
60 B<-noauth> options. For more details, see the introductory
61 B<bos> reference page.
62
63 =item -help
64
65 Prints the online help for this command. All other valid options
66 are 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
78 machine B<fs4.abc.com>. 
79
80    % bos listusers fs4.abc.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(1)>,
90 L<UserList(1)>,
91 L<bos(1)>,
92 L<bos_adduser(1)>,
93 L<bos_removeuser(1)>
94
95 =head1 COPYRIGHT
96
97 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
98
99 This documentation is covered by the IBM Public License Version 1.0.  It was
100 converted from HTML to POD by software written by Chas Williams and Russ
101 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.