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