backport to buster
[hcoop/debian/openafs.git] / doc / man-pages / pod1 / pts_listmax.pod.in
CommitLineData
805e021f
CE
1=head1 NAME
2
3pts_listmax - Displays the max user id and max group id counters
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<pts listmax> S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
11 [B<-force>] [B<-help>] [B<-auth>] [B<-encrypt>]
12 S<<< [B<-config> <I<config directory>>] >>>
13
14B<pts listm> S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>]
15 [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
16
17=for html
18</div>
19
20=head1 DESCRIPTION
21
22The B<pts listmax> command displays the values of the C<max user id> and
23C<max group id> counters, which the Protection Server uses to track the
24AFS user IDs (AFS UIDs) it allocates to new users or machines, and the AFS
25group IDs (AFS GIDs) it allocates to new groups, respectively. When an
26administrator next issues the B<pts createuser> command and does not
27include the B<-id> argument, the new user or machine receives an AFS UID
28one greater than the C<max user id> counter, and when a user issues the
29B<pts creategroup> command and does not include the B<-id> argument, the
30new group receives an AFS UID one less (more negative) than the C<max
31group id> counter.
32
33To reset one or both counters, members of the system:administrators group
34can issue the B<pts setmax> command.
35
36=head1 OPTIONS
37
38=over 4
39
40=include fragments/pts-common.pod
41
42=back
43
44=head1 OUTPUT
45
46The command displays the counters in the following format:
47
48 Max user id is <user_counter> and max group id is <group_counter>.
49
50=head1 EXAMPLES
51
52The following example displays the output of this command:
53
54 % pts listmax
55 Max user name is 1271 and max group id is -382.
56
57=head1 PRIVILEGE REQUIRED
58
59None
60
61=head1 SEE ALSO
62
63L<pts(1)>,
64L<pts_setmax(1)>
65
66=head1 COPYRIGHT
67
68IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
69
70This documentation is covered by the IBM Public License Version 1.0. It was
71converted from HTML to POD by software written by Chas Williams and Russ
72Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.