Fix unterminated B<> sequence in bos addhost man page
[openafs.git] / doc / man-pages / pod1 / pts_setmax.pod.in
1 =head1 NAME
2
3 pts_setmax - Sets the value of the max group id or max user id counter
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<pts setmax> S<<< [B<-group> <I<group max>>] >>> S<<< [B<-user> <I<user max>>] >>>
11     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-force>] [B<-help>]
12
13 B<pts setm> [B<-g> I<group max>>] S<<< [B<-u> <I<user max>>] >>>
14     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>]
15
16 =for html
17 </div>
18
19 =head1 DESCRIPTION
20
21 The B<pts setmax> command sets the value of one or both counters that
22 track the IDs the Protection Server allocates to new users, machines, or
23 groups: the C<max user id> counter for the AFS user IDs (AFS UIDs)
24 assigned to users and machines, and the C<max group id> counter for the
25 AFS group IDs (AFS GIDs) assigned to groups.
26
27 Use the B<pts listmax> command to display the current value of both
28 counters.
29
30 =head1 OPTIONS
31
32 =over 4
33
34 =item B<-group> <I<group max>>
35
36 Sets the C<max group id> counter. Precede the value with a hyphen to
37 indicate that it is negative. When an administrator next uses the B<pts
38 creategroup> command to create a group entry and does not include that
39 command's B<-id> argument, the Protection Server assigns the group an AFS
40 GID one less (more negative) than this value.
41
42 =item B<-user> <I<user max>>
43
44 Sets the C<max user id> counter. When an administrator next uses the B<pts
45 createuser> command to create a user or machine entry and does not include
46 that command's B<-id> argument, the Protection Server assigns the group an
47 AFS UID one greater than this value.
48
49 =include fragments/pts-common.pod
50
51 =back
52
53 =head1 EXAMPLES
54
55 The following command sets the C<max group id> counter to -500 and the
56 C<max user id> counter to 1000.
57
58    % pts setmax -group -500 -user 1000
59
60 =head1 PRIVILEGE REQUIRED
61
62 The issuer must belong to the system:administrators group.
63
64 =head1 SEE ALSO
65
66 L<pts(1)>,
67 L<pts_creategroup(1)>,
68 L<pts_createuser(1)>,
69 L<pts_listmax(1)>
70
71 =head1 COPYRIGHT
72
73 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
74
75 This documentation is covered by the IBM Public License Version 1.0.  It was
76 converted from HTML to POD by software written by Chas Williams and Russ
77 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.