4fec04e46a8435f71636f991e681367bf14314bf
[openafs.git] / doc / man-pages / pod1 / pts_listmax.pod
1 =head1 NAME
2
3 pts_listmax - Displays the max user id and max group id counters
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<pts listmax> S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] 
11     [B<-force>] [B<-help>]
12
13 B<pts listm> S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>]
14
15 =for html
16 </div>
17
18 =head1 DESCRIPTION
19
20 The B<pts listmax> command displays the values of the C<max user id> and
21 C<max group id> counters, which the Protection Server uses to track the
22 AFS user IDs (AFS UIDs) it allocates to new users or machines, and the AFS
23 group IDs (AFS GIDs) it allocates to new groups, respectively. When an
24 administrator next issues the B<pts createuser> command and does not
25 include the B<-id> argument, the new user or machine receives an AFS UID
26 one greater than the C<max user id> counter, and when a user issues the
27 B<pts creategroup> command and does not include the B<-id> argument, the
28 new group receives an AFS UID one less (more negative) than the C<max
29 group id> counter.
30
31 To reset one or both counters, members of the system:administrators group
32 can issue the B<pts setmax> command.
33
34 =head1 OPTIONS
35
36 =over 4
37
38 =item B<-cell> <I<cell name>>
39
40 Names the cell in which to run the command. For more details, see
41 L<pts(1)>.
42
43 =item B<-noauth>
44
45 Assigns the unprivileged identity anonymous to the issuer. For more
46 details, see L<pts(1)>.
47
48 =item B<-localauth>
49
50 Constructs a server ticket using a key from the local
51 F</usr/afs/etc/KeyFile> file. Do not combine this flag with the 
52 B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
53
54 =item B<-force>
55
56 Enables the command to continue executing as far as possible when errors
57 or other problems occur, rather than halting execution at the first error.
58
59 =item B<-help>
60
61 Prints the online help for this command. All other valid options are
62 ignored.
63
64 =back
65
66 =head1 OUTPUT
67
68 The command displays the counters in the following format:
69
70    Max user id is <user_counter> and max group id is <group_counter>.
71
72 =head1 EXAMPLES
73
74 The following example displays the output of this command:
75
76    % pts listmax
77    Max user name is 1271 and max group id is -382.
78
79 =head1 PRIVILEGE REQUIRED
80
81 None
82
83 =head1 SEE ALSO
84
85 L<pts(1)>,
86 L<pts_setmax(1)>
87
88 =head1 COPYRIGHT
89
90 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
91
92 This documentation is covered by the IBM Public License Version 1.0.  It was
93 converted from HTML to POD by software written by Chas Williams and Russ
94 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.