8c31340e70876a421453dbc006b7c14808349859
[openafs.git] / doc / man-pages / pod1 / pts.pod
1 =head1 NAME
2
3 pts - Introduction to the pts command suite
4
5 =head1 DESCRIPTION
6
7 The commands in the B<pts> command suite are the administrative interface
8 to the Protection Server, which runs on each database server machine in a
9 cell and maintains the Protection Database. The database stores the
10 information that AFS uses to augment and refine the standard UNIX scheme
11 for controlling access to files and directories.
12
13 Instead of relying only on the mode bits that define access rights for
14 individual files, AFS associates an access control list (ACL) with each
15 directory. The ACL lists users and groups and specifies which of seven
16 possible access permissions they have for the directory and the files it
17 contains. (It is still possible to set a directory or file's mode bits,
18 but AFS interprets them in its own way; see the chapter on protection in
19 the I<IBM AFS Administration Guide> for details.)
20
21 AFS enables users to define groups in the Protection Database and place
22 them on ACLs to extend a set of rights to multiple users simultaneously.
23 Groups simplify administration by making it possible to add someone to
24 many ACLs by adding them to a group that already exists on those
25 ACLs. Machines can also be members of a group, so that users logged into
26 the machine automatically inherit the permissions granted to the group.
27
28 There are several categories of commands in the pts command suite:
29
30 =over 4
31
32 =item *
33
34 Commands to create and remove Protection Database entries: B<pts
35 creategroup>, B<pts createuser>, and B<pts delete>.
36
37 =item *
38
39 Commands to administer and display group membership: B<pts adduser>, B<pts
40 listowned>, B<pts membership>, and B<pts removeuser>.
41
42 =item *
43
44 Commands to administer and display properties of user and group entries
45 other than membership: B<pts chown>, B<pts examine>, B<pts listentries>,
46 B<pts rename>, and B<pts setfields>.
47
48 =item *
49
50 Commands to set and examine the counters used when assigning IDs to users
51 and groups: B<pts listmax> and B<pts setmax>.
52
53 =item *
54
55 Commands to obtain help: B<pts apropos> and B<pts help>.
56
57 =back
58
59 =head1 OPTIONS
60
61 The following arguments and flags are available on many commands in the
62 B<pts> suite. The reference page for each command also lists them, but
63 they are described here in greater detail.
64
65 =over 4
66
67 =item B<-cell> <I<cell name>>
68
69 Names the cell in which to run the command. It is acceptable to abbreviate
70 the cell name to the shortest form that distinguishes it from the other
71 entries in the F</usr/vice/etc/CellServDB> file on the local machine. If
72 the B<-cell> argument is omitted, the command interpreter determines the
73 name of the local cell by reading the following in order:
74
75 =over 4
76
77 =item *
78
79 The value of the AFSCELL environment variable.
80
81 =item *
82
83 The local F</usr/vice/etc/ThisCell> file.
84
85 =back
86
87 =item B<-force>
88
89 Enables the command to continue executing as far as possible when errors
90 or other problems occur, rather than halting execution immediately.
91 Without it, the command halts as soon as the first error is
92 encountered. In either case, the B<pts> command interpreter reports errors
93 at the command shell. This flag is especially useful if the issuer
94 provides many values for a command line argument; if one of them is
95 invalid, the command interpreter continues on to process the remaining
96 arguments.
97
98 =item B<-help>
99
100 Prints a command's online help message on the standard output stream. Do
101 not combine this flag with any of the command's other options; when it is
102 provided, the command interpreter ignores all other options, and only
103 prints the help message.
104
105 =item B<-noauth>
106
107 Establishes an unauthenticated connection to the Protection Server, in
108 which the server treats the issuer as the unprivileged user
109 C<anonymous>. It is useful only when authorization checking is disabled on
110 the server machine (during the installation of a file server machine or
111 when the B<bos setauth> command has been used during other unusual
112 circumstances). In normal circumstances, the Protection Server allows only
113 privileged users to issue commands that change the Protection Database,
114 and refuses to perform such an action even if the B<-noauth> flag is
115 provided.
116
117 =back
118
119 =head1 PRIVILEGE REQUIRED
120
121 Members of the system:administrators group can issue all B<pts> commands
122 on any entry in the Protection Database.
123
124 Users who do not belong to the system:administrators group can list
125 information about their own entry and any group entries they own. The
126 privacy flags set with the B<pts setfields> command control access to
127 entries owned by other users.
128
129 =head1 SEE ALSO
130
131 L<pts_adduser(1)>,
132 L<pts_apropos(1)>,
133 L<pts_chown(1)>,
134 L<pts_creategroup(1)>,
135 L<pts_createuser(1)>,
136 L<pts_delete(1)>,
137 L<pts_examine(1)>,
138 L<pts_help(1)>,
139 L<pts_listentries(1)>,
140 L<pts_listmax(1)>,
141 L<pts_listowned(1)>,
142 L<pts_membership(1)>,
143 L<pts_removeuser(1)>,
144 L<pts_rename(1)>,
145 L<pts_setfields(1)>,
146 L<pts_setmax(1)>
147
148 =head1 COPYRIGHT
149
150 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
151
152 This documentation is covered by the IBM Public License Version 1.0.  It was
153 converted from HTML to POD by software written by Chas Williams and Russ
154 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.