doc: pts manpage fixes
authorAndrew Deason <adeason@sinenomine.net>
Wed, 12 Jun 2013 23:22:27 +0000 (18:22 -0500)
committerDerrick Brashear <shadow@your-file-system.com>
Mon, 4 Nov 2013 04:36:16 +0000 (20:36 -0800)
 - Mention the -help, -auth, -encrypt, and -config options for all pts
   commands in their synopsis

 - Add the -auth option to the pts.pod page

 - Reference the -auth, -encrypt, and -config options from all
   subcommand pts pages

 - pts_removeuser: Replace -name with -user

 - pts_sleep: Add missing -delay

 - pts_source: Add missing -file

Change-Id: I4f0889d661c46f6bdd2a9604d8423d809a632d2d
Reviewed-on: http://gerrit.openafs.org/10387
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Derrick Brashear <shadow@your-file-system.com>

20 files changed:
doc/man-pages/pod1/fragments/pts-common.pod
doc/man-pages/pod1/pts.pod
doc/man-pages/pod1/pts_adduser.pod.in
doc/man-pages/pod1/pts_chown.pod.in
doc/man-pages/pod1/pts_creategroup.pod.in
doc/man-pages/pod1/pts_createuser.pod.in
doc/man-pages/pod1/pts_delete.pod.in
doc/man-pages/pod1/pts_examine.pod.in
doc/man-pages/pod1/pts_interactive.pod.in
doc/man-pages/pod1/pts_listentries.pod.in
doc/man-pages/pod1/pts_listmax.pod.in
doc/man-pages/pod1/pts_listowned.pod.in
doc/man-pages/pod1/pts_membership.pod.in
doc/man-pages/pod1/pts_quit.pod.in
doc/man-pages/pod1/pts_removeuser.pod.in
doc/man-pages/pod1/pts_rename.pod.in
doc/man-pages/pod1/pts_setfields.pod.in
doc/man-pages/pod1/pts_setmax.pod.in
doc/man-pages/pod1/pts_sleep.pod.in
doc/man-pages/pod1/pts_source.pod.in

index 055262d..dfb90c5 100644 (file)
@@ -1,8 +1,22 @@
+=item B<-auth>
+
+Use the calling user's tokens to communicate with the Protection Server. For
+more details, see L<pts(1)>.
+
 =item B<-cell> <I<cell name>>
 
 Names the cell in which to run the command. For more details, see
 L<pts(1)>.
 
+=item B<-config> <I<config directory>>
+
+Use an alternate config directory. For more details, see L<pts(1)>.
+
+=item B<-encrypt>
+
+Encrypts any communication with the Protection Server. For more details, see
+L<pts(1)>.
+
 =item B<-force>
 
 Enables the command to continue executing as far as possible when errors
index 0720f0b..f3417ba 100644 (file)
@@ -179,6 +179,18 @@ whereas a command on which the B<-cell> argument is included runs in the
 specified foreign cell. Also, do not combine the B<-localauth> and
 B<-noauth> flags.
 
+=item B<-auth>
+
+Use the calling user's tokens from the kernel to communicate with the ptserver
+(that is, the same tokens displayed by L<tokens(1)>. This is the default if
+neither B<-localauth> nor B<-noauth> is given.
+
+Since this option is the default, it is usually not useful for running single
+command line operations. However, it can be useful when running commands via
+L<pts_interactive(1)>, since otherwise it would be impossible to switch from,
+for example, B<-localauth> back to using regular tokens during a bulk
+operation. See L<pts_interactive(1)> for more details.
+
 =back
 
 =head1 PRIVILEGE REQUIRED
index 5d259bf..e9b10d6 100644 (file)
@@ -9,9 +9,11 @@ pts_adduser - Adds a user or machine to a Protection Database group
 
 B<pts adduser> S<<< B<-user> <I<user name>>+ >>> S<<< B<-group> <I<group name>>+ >>>
     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-force>] [B<-help>]
+    [B<-auth>] [B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
 
 B<pts ad> S<<< B<-u> <I<user name>>+ >>> S<<< B<-g> <I<group name>>+ >>>
     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>]
+    [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
index 498b85f..bfdbf7a 100644 (file)
@@ -9,9 +9,11 @@ pts_chown - Changes the owner of a Protection Database entry
 
 B<pts chown> S<<< B<-name> <I<group name>> >>> S<<< B<-owner> <I<new owner>> >>>
     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-force>] [B<-help>]
+    [B<-auth>] [B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
 
 B<pts cho> S<<< B<-na> <I<group name>> >>> S<<< B<-o> <I<new owner>> >>>
     S<<< [B<-c> <I<cell name>>] >>> [B<-no>] [B<-l>] [B<-f>] [B<-h>]
+    [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
index e399f27..d2589ac 100644 (file)
@@ -11,14 +11,17 @@ B<pts creategroup> S<<< B<-name> <I<group name>>+ >>>
     S<<< [B<-owner> <I<owner of the group>>] >>>
     S<<< [B<-id> <I<id (negated) for the group>>+] >>> S<<< [B<-cell> <I<cell name>>] >>>
     [B<-noauth>] [B<-localauth>] [B<-force>] [B<-help>]
+    [B<-auth>] [B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
 
 B<pts createg> S<<< B<-na> <I<group name>>+ >>>  S<<< [B<-o> <I<owner of the group>>] >>>
     S<<< [B<-i> <I<id (negated) for the group>>+] >>> S<<< [B<-c> <I<cell name>>] >>>
     [B<-no>] [B<-l>] [B<-f>] [B<-h>]
+    [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 B<pts cg> S<<< B<-na> <I<group name>>+ >>> S<<< [B<-o> <I<owner of the group>>] >>>
     S<<< [B<-i> <I<id (negated) for the group>>+] >>> S<<< [B<-c> <I<cell name>>] >>>
     [B<-no>] [B<-l>] [B<-f>] [B<-h>]
+    [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
index 816278f..05fcd68 100644 (file)
@@ -9,13 +9,15 @@ pts_createuser - Creates a user or machine entry in the Protection Database
 
 B<pts createuser> S<<< B<-name> <I<user name>>+ >>> S<<< [B<-id> <I<user id>>+] >>>
     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-force>] 
-    [B<-help>]
+    [B<-help>] [B<-auth>] [B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
 
 B<pts createu> S<<< B<-na> <I<user name>>+ >>> S<<< [B<-i> <I<user id>>+] >>>
     S<<< [B<-c> <I<cell name>>] >>> [B<-no>] [B<-l>] [B<-f>] [B<-h>]
+    [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 B<pts cu> S<<< B<-na> <I<user name>>+ >>> S<<< [B<-i> <I<user id>>+] >>>
     S<<< [B<-c> <I<cell name>>] >>> [B<-no>] [B<-l>] [B<-f>] [B<-h>]
+    [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
index 7932fec..c2080dc 100644 (file)
@@ -9,10 +9,12 @@ pts_delete - Deletes a Protection Database entry
 
 B<pts delete> S<<< B<-nameorid> <I<user or group name or id>>+ >>>
     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] 
-    [B<-force>] [B<-help>]
+    [B<-force>] [B<-help>] [B<-auth>] [B<-encrypt>]
+    S<<< [B<-config> <I<config directory>>] >>>
 
 B<pts d> S<<< B<-na> <I<user or group name or id>>+ >>>
     S<<< [B<-c> <I<cell name>>] >>> [B<-no>] [B<-l>] [B<-f>] [-h]
+    [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
index 154ff78..d8aa20c 100644 (file)
@@ -10,15 +10,19 @@ pts_examine - Displays a Protection Database entry
 B<pts examine> S<<< B<-nameorid> <I<user or group name or id>>+ >>>
     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] 
     [B<-force>] [B<-auth>] [B<-help>]
+    [B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
 
 B<pts e> S<<< B<-na> <I<user or group name or id>>+ >>> S<<< [B<-c> <I<cell name>>] >>>
     [B<-no>] [B<-l>] [B<-f>] [B<-a>] [B<-h>]
+    [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 B<pts check> S<<< B<-na> <I<user or group name or id>>+ >>> S<<< [B<-c> <I<cell name>>] >>>
     [B<-no>] [B<-l>] [B<-f>] [B<-a>] [B<-h>]
+    [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 B<pts che> S<<< B<-na> <I<user or group name or id>>+ >>> S<<< [B<-c> <I<cell name>>] >>>
     [B<-no>] [B<-l>] [B<-f>] [B<-a>] [B<-h>]
+    [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
@@ -42,11 +46,6 @@ acceptable to mix users, machines, and groups on the same command line, as
 well as names (IP addresses for machines) and IDs. Precede the GID of each
 group with a hyphen to indicate that it is negative.
 
-=item B<-auth>
-
-Run using the user's current authentication. This is the default unless
-the B<-noauth> or B<-localauth> options are used.
-
 =include fragments/pts-common.pod
 
 =back
index c1aa51a..a0338da 100644 (file)
@@ -8,9 +8,12 @@ pts_interactive - Enters interactive mode
 <div class="synopsis">
 
 B<pts interactive> S<<< [B<-cell>] <I<cell name>> >>> [B<-noauth>]
-    [B<-auth>] [B<-localauth>] [B<-force>]
+    [B<-auth>] [B<-localauth>] [B<-force>] [B<-help>]
+    [B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
 
-B<pts in> S<<< [B<-c>] <I<cell name>> >>> [B<-n>] [B<-f>]
+
+B<pts in> S<<< [B<-c>] <I<cell name>> >>> [B<-n>] [B<-f>] [B<-h>]
+    [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
index e2e663b..321b052 100644 (file)
@@ -9,9 +9,10 @@ pts_listentries - Displays all users or groups in the Protection Database
 
 B<pts listentries> [B<-users>] [B<-groups>] S<<< [B<-cell> <I<cell name>>] >>>
     [B<-noauth>] [B<-localauth>] [B<-force>] [B<-help>]
+    [B<-auth>] [B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
 
 B<pts liste> [B<-u>] [B<-g>] S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] 
-             [B<-f>] [B<-h>]
+    [B<-f>] [B<-h>] [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
index 790face..aee5729 100644 (file)
@@ -8,9 +8,11 @@ pts_listmax - Displays the max user id and max group id counters
 <div class="synopsis">
 
 B<pts listmax> S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] 
-    [B<-force>] [B<-help>]
+    [B<-force>] [B<-help>] [B<-auth>] [B<-encrypt>]
+    S<<< [B<-config> <I<config directory>>] >>>
 
 B<pts listm> S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>]
+    [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
index c04ddec..9b0c2cf 100644 (file)
@@ -9,9 +9,11 @@ pts_listowned - Show the Protection Database groups owned by a user or group
 
 B<pts listowned> S<<< B<-nameorid> <I<user or group name or id>>+ >>>
     [-cell <I<cell name>>] [B<-noauth>] [B<-localauth>] [B<-force>] [B<-help>]
+    [B<-auth>] [B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
 
 B<pts listo> S<<< B<-na> <I<user or group name or id>>+ >>>
     [-c <I<cell name>>] [B<-no>] [B<-l>] [B<-f>] [B<-h>]
+    [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
index c70e24e..b124baf 100644 (file)
@@ -10,18 +10,22 @@ pts_membership - Displays the membership list for a user or group
 B<pts membership> S<<< B<-nameorid> <I<user or group name or id>>+ >>>
     [B<-supergroups>] [B<-expandgroups>] S<<< [B<-cell> <I<cell name>>] >>>
     [B<-localauth>] [B<-noauth>] [B<-force>] [B<-help>]
+    [B<-auth>] [B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
 
 B<pts m> S<<< B<-na> <I<user or group name or id>>+ >>>
     [B<-s>] [B<-ex>] S<<< [B<-c> <I<cell name>>] >>>
     [B<-no>] [B<-l>] [B<-f>] [B<-h>]
+    [B<-a>] [B<-en>] S<<< [B<-co> <I<config directory>>] >>>
 
 B<pts groups> S<<< B<-na> <I<user or group name or id>>+ >>>
     [B<-s>] [B<-ex>] S<<< [B<-c> <I<cell name>>] >>>
     [B<-no>] [B<-l>] [B<-f>] [B<-h>]
+    [B<-a>] [B<-en>] S<<< [B<-co> <I<config directory>>] >>>
 
 B<pts g> S<<< B<-na> <I<user or group name or id>>+ >>>
     [B<-s>] [B<-ex>] S<<< [B<-c> <I<cell name>>] >>>
     [B<-no>] [B<-l>] [B<-f>] [B<-h>]
+    [B<-a>] [B<-en>] S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
index d742ec9..0fbf780 100644 (file)
@@ -8,9 +8,11 @@ pts_quit - Exit from pts interactive mode
 <div class="synopsis">
 
 B<pts quit> S<<< [B<-cell>] <I<cell name>> >>> [B<-noauth>] [B<-localauth>] 
-    [B<-force>]
+    [B<-force>] [B<-help>] [B<-auth>] [B<-encrypt>]
+    S<<< [B<-config> <I<config directory>>] >>>
 
-B<pts q> S<<< [B<-c>] <I<cell name>> >>> [B<-n>] [B<-l>] [B<-f>]
+B<pts q> S<<< [B<-c>] <I<cell name>> >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>]
+    [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
index 4dcf213..d0a02b9 100644 (file)
@@ -9,10 +9,11 @@ pts_removeuser - Removes a user from a Protection Database group
 
 B<pts removeuser> S<<< B<-user> <I<user name>>+ >>> S<<< B<-group> <I<group name>>+ >>>
     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-force>] 
-    [B<-help>]
+    [B<-help>] [B<-auth>] [B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
 
 B<pts rem> S<<< B<-u> <I<user name>>+ >>> S<<< B<-g> <I<group name>>+ >>>
     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>]
+    [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
@@ -38,7 +39,7 @@ tokens or reauthenticate.
 
 =over 4
 
-=item B<-name> <I<user name>>+
+=item B<-user> <I<user name>>+
 
 Specifies the name of each user entry or the IP address (complete or
 wildcard-style) of each machine entry to remove.
index 775feec..8245296 100644 (file)
@@ -9,10 +9,12 @@ pts_rename - Changes the name of a Protection Database entry
 
 B<pts rename> S<<< B<-oldname> <I<old name>> >>> S<<< B<-newname> <I<new name>> >>>
     S<<< [B<-cell> <I<cell name>>] >>>  [B<-noauth>]  [B<-localauth>]  
-    [B<-force>]  [B<-help>]
+    [B<-force>] [B<-help>] [B<-auth>] [B<-encrypt>]
+    S<<< [B<-config> <I<config directory>>] >>>
 
 B<pts ren> S<<< B<-o> <I<old name>> >>> S<<< B<-ne> <I<new name>> >>> S<<< [B<-c> <I<cell name>>] >>>
-    [B<-no>] [B<-l>] [B<-f>] [B<-h>]
+    [B<-no>] [B<-l>] [B<-f>] [B<-h>] [B<-a>] [B<-e>]
+    S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
index b6c9d19..a914454 100644 (file)
@@ -11,12 +11,14 @@ B<pts setfields> S<<< B<-nameorid> <I<user or group name or id>>+ >>>
     S<<< [B<-access> <I<set privacy flags>>] >>>
     S<<< [B<-groupquota> <I<set limit on group creation>>] >>>
     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
-    [B<-force>] [B<-help>]
+    [B<-force>] [B<-help>] [B<-auth>] [B<-encrypt>]
+    S<<< [B<-config> <I<config directory>>] >>>
 
 B<pts setf> S<<< B<-na> <I<user or group name or id>>+ >>>
-    S<<< [B<-a> <I<set privacy flags>>] >>>
+    S<<< [B<-ac> <I<set privacy flags>>] >>>
     S<<< [B<-g> <I<set limit on group creation>>] >>> S<<< [B<-c> <I<cell name>>] >>>
-    [B<-no>] [B<-l>] [B<-f>] [B<-h>]
+    [B<-no>] [B<-l>] [B<-f>] [B<-h>] [B<-au>] [B<-e>]
+    S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
index 1bfca5e..d9fe75a 100644 (file)
@@ -9,9 +9,11 @@ pts_setmax - Sets the value of the max group id or max user id counter
 
 B<pts setmax> S<<< [B<-group> <I<group max>>] >>> S<<< [B<-user> <I<user max>>] >>>
     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-force>] [B<-help>]
+    [B<-auth>] [B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
 
 B<pts setm> [B<-g> I<group max>>] S<<< [B<-u> <I<user max>>] >>>
     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>]
+    [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
index f59d271..3e7c135 100644 (file)
@@ -9,9 +9,11 @@ pts_sleep - Pauses for a few seconds
 
 B<pts sleep> S<<< [B<-delay>] <I<# of seconds>> >>>
    S<<< [B<-cell>] <I<cell name>> >>> [B<-noauth>] [B<-localauth>] [B<-force>]
+   [B<-help>] [B<-auth>] [B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
 
 B<pts sl> S<<< [B<-d>] <I<# of seconds>> >>> S<<< [B<-c>] <I<cell name>> >>>
-   [B<-n>] [B<-l>] [B<-f>]
+   [B<-n>] [B<-l>] [B<-f>] [B<-h>]
+   [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
@@ -38,6 +40,10 @@ B<pts> options:
 
 =over 4
 
+=item B<-delay> <I<# of seconds>>
+
+Specifies the amount of time to sleep, in seconds.
+
 =include fragments/pts-common.pod
 
 =back
index 3179815..24da00d 100644 (file)
@@ -8,10 +8,11 @@ pts_source - Read pts commands from a file
 <div class="synopsis">
 
 B<pts source> S<<< [B<-file>] <I<file name>> >>> S<<< [B<-cell>] <I<cell name>> >>>
-   [B<-noauth>] [B<-localauth>] [B<-force>]
+   [B<-noauth>] [B<-localauth>] [B<-force>] [B<-auth>] [B<-encrypt>] [B<-help>]
+   S<<< [B<-config> <I<config directory>>] >>>
 
 B<pts so> S<<< [B<-f>] <I<file name>> >>> S<<< [B<-c>] <I<cell name>> >>>
-   [B<-n>] [B<-l>] [B<-f>]
+   [B<-n>] [B<-l>] [B<-f>] [B<-h>] [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
 
 =for html
 </div>
@@ -35,6 +36,11 @@ B<pts source> takes the following options:
 
 =over 4
 
+=item B<-file> <I<file name>>
+
+Specifies the file name to read commands from. The commands in the given file
+are run as if they were typed in pts interactive mode.
+
 =include fragments/pts-common.pod
 
 =back