pts: Add the -config option

[openafs.git] / doc / man-pages / pod1 / pts.pod

diff --git a/doc/man-pages/pod1/pts.pod b/doc/man-pages/pod1/pts.pod
index 913a9ff..0720f0b 100644 (file)
--- a/doc/man-pages/pod1/pts.pod
+++ b/doc/man-pages/pod1/pts.pod
@@ -16,7 +16,7 @@ directory. The ACL lists users and groups and specifies which of seven
 possible access permissions they have for the directory and the files it
 contains. (It is still possible to set a directory or file's mode bits,
 but AFS interprets them in its own way; see the chapter on protection in
-the I<IBM AFS Administration Guide> for details.)
+the I<OpenAFS Administration Guide> for details.)
 
 AFS enables users to define groups in the Protection Database and place
 them on ACLs to extend a set of rights to multiple users simultaneously.
@@ -31,37 +31,53 @@ There are several categories of commands in the pts command suite:
 
 =item *
 
-Commands to create and remove Protection Database entries: B<pts
-creategroup>, B<pts createuser>, and B<pts delete>.
+Commands to create and remove Protection Database entries:
+L<B<pts creategroup>|pts_creategroup(1)>,
+L<B<pts createuser>|pts_createuser(1)>,
+and L<B<pts delete>|pts_delete(1)>.
 
 =item *
 
-Commands to administer and display group membership: B<pts adduser>, B<pts
-listowned>, B<pts membership>, and B<pts removeuser>.
+Commands to administer and display group membership:
+L<B<pts adduser>|pts_adduser(1)>,
+L<B<pts listowned>|pts_listowned(1)>,
+L<B<pts membership>|pts_membership(1)>,
+and L<B<pts removeuser>|pts_removeuser(1)>.
 
 =item *
 
 Commands to administer and display properties of user and group entries
-other than membership: B<pts chown>, B<pts examine>, B<pts listentries>,
-B<pts rename>, and B<pts setfields>.
+other than membership:
+L<B<pts chown>|pts_chown(1)>,
+L<B<pts examine>|pts_examine(1)>,
+L<B<pts listentries>|pts_listentries(1)>,
+L<B<pts rename>|pts_rename(1)>,
+and L<B<pts setfields>|pts_setfields(1)>.
 
 =item *
 
 Commands to set and examine the counters used when assigning IDs to users
-and groups: B<pts listmax> and B<pts setmax>.
+and groups:
+L<B<pts listmax>|pts_listmax(1)>
+and L<B<pts setmax>|pts_setmax(1)>.
 
 =item *
 
-Commands to run commands interactively: B<pts interactive>, B<pts
-sleep>, and B<pts quit>.
+Commands to run commands interactively:
+L<B<pts interactive>|pts_interactive(1)>,
+L<B<pts sleep>|pts_sleep(1)>,
+and L<B<pts quit>|pts_quit(1)>.
 
 =item *
 
-A command to run commands from a file: B<pts source>.
+A command to run commands from a file:
+L<B<pts source>|pts_source(1)>.
 
 =item *
 
-Commands to obtain help: B<pts apropos> and B<pts help>.
+Commands to obtain help:
+L<B<pts apropos>|pts_apropos(1)>
+and L<B<pts help>|pts_help(1)>.
 
 =back
 
@@ -99,6 +115,11 @@ specified foreign cell.
 
 =back
 
+=item B<-config> <I<config directory>>
+
+The location of the directory to use to obtain configuration information,
+including the CellServDB. This is primarily provided for testing purposes.
+
 =item B<-force>
 
 Enables the command to continue executing as far as possible when errors
@@ -123,11 +144,17 @@ Establishes an unauthenticated connection to the Protection Server, in
 which the server treats the issuer as the unprivileged user
 C<anonymous>. It is useful only when authorization checking is disabled on
 the server machine (during the installation of a file server machine or
-when the B<bos setauth> command has been used during other unusual
-circumstances). In normal circumstances, the Protection Server allows only
-privileged users to issue commands that change the Protection Database,
-and refuses to perform such an action even if the B<-noauth> flag is
-provided.
+when the L<B<bos setauth>|bos_setauth(8)> command has been used during
+other unusual circumstances). In normal circumstances, the Protection
+Server allows only privileged users to issue commands that change the
+Protection Database, and refuses to perform such an action even if the
+B<-noauth> flag is provided.
+
+=item B<-encrypt>
+
+Establishes an authenticated, encrypted connection to the Protection Server.
+It is useful when it is desired to obscure network traffic related to the
+transactions being done.
 
 =item B<-localauth>
 
@@ -161,8 +188,8 @@ on any entry in the Protection Database.
 
 Users who do not belong to the system:administrators group can list
 information about their own entry and any group entries they own. The
-privacy flags set with the B<pts setfields> command control access to
-entries owned by other users.
+privacy flags set with the L<B<pts setfields>|pts_setfields(1)> command
+control access to entries owned by other users.
 
 =head1 SEE ALSO
 
@@ -187,6 +214,9 @@ L<pts_setmax(1)>,
 L<pts_sleep(1)>,
 L<pts_source(1)>
 
+The I<OpenAFS Administration Guide> at
+L<http://docs.openafs.org/AdminGuide/>.
+
 =head1 COPYRIGHT
 
 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.