From f69bf0b19490ddde05917f7467383bbe248e81c4 Mon Sep 17 00:00:00 2001 From: Andrew Deason Date: Wed, 12 Jun 2013 18:22:27 -0500 Subject: [PATCH] doc: pts manpage fixes - 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 Reviewed-by: Derrick Brashear --- doc/man-pages/pod1/fragments/pts-common.pod | 14 ++++++++++++++ doc/man-pages/pod1/pts.pod | 12 ++++++++++++ doc/man-pages/pod1/pts_adduser.pod.in | 2 ++ doc/man-pages/pod1/pts_chown.pod.in | 2 ++ doc/man-pages/pod1/pts_creategroup.pod.in | 3 +++ doc/man-pages/pod1/pts_createuser.pod.in | 4 +++- doc/man-pages/pod1/pts_delete.pod.in | 4 +++- doc/man-pages/pod1/pts_examine.pod.in | 9 ++++----- doc/man-pages/pod1/pts_interactive.pod.in | 7 +++++-- doc/man-pages/pod1/pts_listentries.pod.in | 3 ++- doc/man-pages/pod1/pts_listmax.pod.in | 4 +++- doc/man-pages/pod1/pts_listowned.pod.in | 2 ++ doc/man-pages/pod1/pts_membership.pod.in | 4 ++++ doc/man-pages/pod1/pts_quit.pod.in | 6 ++++-- doc/man-pages/pod1/pts_removeuser.pod.in | 5 +++-- doc/man-pages/pod1/pts_rename.pod.in | 6 ++++-- doc/man-pages/pod1/pts_setfields.pod.in | 8 +++++--- doc/man-pages/pod1/pts_setmax.pod.in | 2 ++ doc/man-pages/pod1/pts_sleep.pod.in | 8 +++++++- doc/man-pages/pod1/pts_source.pod.in | 10 ++++++++-- 20 files changed, 92 insertions(+), 23 deletions(-) diff --git a/doc/man-pages/pod1/fragments/pts-common.pod b/doc/man-pages/pod1/fragments/pts-common.pod index 055262d..dfb90c5 100644 --- a/doc/man-pages/pod1/fragments/pts-common.pod +++ b/doc/man-pages/pod1/fragments/pts-common.pod @@ -1,8 +1,22 @@ +=item B<-auth> + +Use the calling user's tokens to communicate with the Protection Server. For +more details, see L. + =item B<-cell> > Names the cell in which to run the command. For more details, see L. +=item B<-config> > + +Use an alternate config directory. For more details, see L. + +=item B<-encrypt> + +Encrypts any communication with the Protection Server. For more details, see +L. + =item B<-force> Enables the command to continue executing as far as possible when errors diff --git a/doc/man-pages/pod1/pts.pod b/doc/man-pages/pod1/pts.pod index 0720f0b..f3417ba 100644 --- a/doc/man-pages/pod1/pts.pod +++ b/doc/man-pages/pod1/pts.pod @@ -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. 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, since otherwise it would be impossible to switch from, +for example, B<-localauth> back to using regular tokens during a bulk +operation. See L for more details. + =back =head1 PRIVILEGE REQUIRED diff --git a/doc/man-pages/pod1/pts_adduser.pod.in b/doc/man-pages/pod1/pts_adduser.pod.in index 5d259bf..e9b10d6 100644 --- a/doc/man-pages/pod1/pts_adduser.pod.in +++ b/doc/man-pages/pod1/pts_adduser.pod.in @@ -9,9 +9,11 @@ pts_adduser - Adds a user or machine to a Protection Database group B S<<< B<-user> >+ >>> S<<< B<-group> >+ >>> S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] [B<-force>] [B<-help>] + [B<-auth>] [B<-encrypt>] S<<< [B<-config> >] >>> B S<<< B<-u> >+ >>> S<<< B<-g> >+ >>> S<<< [B<-c> >] >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>] + [B<-a>] [B<-e>] S<<< [B<-co> >] >>> =for html diff --git a/doc/man-pages/pod1/pts_chown.pod.in b/doc/man-pages/pod1/pts_chown.pod.in index 498b85f..bfdbf7a 100644 --- a/doc/man-pages/pod1/pts_chown.pod.in +++ b/doc/man-pages/pod1/pts_chown.pod.in @@ -9,9 +9,11 @@ pts_chown - Changes the owner of a Protection Database entry B S<<< B<-name> > >>> S<<< B<-owner> > >>> S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] [B<-force>] [B<-help>] + [B<-auth>] [B<-encrypt>] S<<< [B<-config> >] >>> B S<<< B<-na> > >>> S<<< B<-o> > >>> S<<< [B<-c> >] >>> [B<-no>] [B<-l>] [B<-f>] [B<-h>] + [B<-a>] [B<-e>] S<<< [B<-co> >] >>> =for html diff --git a/doc/man-pages/pod1/pts_creategroup.pod.in b/doc/man-pages/pod1/pts_creategroup.pod.in index e399f27..d2589ac 100644 --- a/doc/man-pages/pod1/pts_creategroup.pod.in +++ b/doc/man-pages/pod1/pts_creategroup.pod.in @@ -11,14 +11,17 @@ B S<<< B<-name> >+ >>> S<<< [B<-owner> >] >>> S<<< [B<-id> >+] >>> S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] [B<-force>] [B<-help>] + [B<-auth>] [B<-encrypt>] S<<< [B<-config> >] >>> B S<<< B<-na> >+ >>> S<<< [B<-o> >] >>> S<<< [B<-i> >+] >>> S<<< [B<-c> >] >>> [B<-no>] [B<-l>] [B<-f>] [B<-h>] + [B<-a>] [B<-e>] S<<< [B<-co> >] >>> B S<<< B<-na> >+ >>> S<<< [B<-o> >] >>> S<<< [B<-i> >+] >>> S<<< [B<-c> >] >>> [B<-no>] [B<-l>] [B<-f>] [B<-h>] + [B<-a>] [B<-e>] S<<< [B<-co> >] >>> =for html diff --git a/doc/man-pages/pod1/pts_createuser.pod.in b/doc/man-pages/pod1/pts_createuser.pod.in index 816278f..05fcd68 100644 --- a/doc/man-pages/pod1/pts_createuser.pod.in +++ b/doc/man-pages/pod1/pts_createuser.pod.in @@ -9,13 +9,15 @@ pts_createuser - Creates a user or machine entry in the Protection Database B S<<< B<-name> >+ >>> S<<< [B<-id> >+] >>> S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] [B<-force>] - [B<-help>] + [B<-help>] [B<-auth>] [B<-encrypt>] S<<< [B<-config> >] >>> B S<<< B<-na> >+ >>> S<<< [B<-i> >+] >>> S<<< [B<-c> >] >>> [B<-no>] [B<-l>] [B<-f>] [B<-h>] + [B<-a>] [B<-e>] S<<< [B<-co> >] >>> B S<<< B<-na> >+ >>> S<<< [B<-i> >+] >>> S<<< [B<-c> >] >>> [B<-no>] [B<-l>] [B<-f>] [B<-h>] + [B<-a>] [B<-e>] S<<< [B<-co> >] >>> =for html diff --git a/doc/man-pages/pod1/pts_delete.pod.in b/doc/man-pages/pod1/pts_delete.pod.in index 7932fec..c2080dc 100644 --- a/doc/man-pages/pod1/pts_delete.pod.in +++ b/doc/man-pages/pod1/pts_delete.pod.in @@ -9,10 +9,12 @@ pts_delete - Deletes a Protection Database entry B S<<< B<-nameorid> >+ >>> S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] - [B<-force>] [B<-help>] + [B<-force>] [B<-help>] [B<-auth>] [B<-encrypt>] + S<<< [B<-config> >] >>> B S<<< B<-na> >+ >>> S<<< [B<-c> >] >>> [B<-no>] [B<-l>] [B<-f>] [-h] + [B<-a>] [B<-e>] S<<< [B<-co> >] >>> =for html diff --git a/doc/man-pages/pod1/pts_examine.pod.in b/doc/man-pages/pod1/pts_examine.pod.in index 154ff78..d8aa20c 100644 --- a/doc/man-pages/pod1/pts_examine.pod.in +++ b/doc/man-pages/pod1/pts_examine.pod.in @@ -10,15 +10,19 @@ pts_examine - Displays a Protection Database entry B S<<< B<-nameorid> >+ >>> S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] [B<-force>] [B<-auth>] [B<-help>] + [B<-encrypt>] S<<< [B<-config> >] >>> B S<<< B<-na> >+ >>> S<<< [B<-c> >] >>> [B<-no>] [B<-l>] [B<-f>] [B<-a>] [B<-h>] + [B<-e>] S<<< [B<-co> >] >>> B S<<< B<-na> >+ >>> S<<< [B<-c> >] >>> [B<-no>] [B<-l>] [B<-f>] [B<-a>] [B<-h>] + [B<-e>] S<<< [B<-co> >] >>> B S<<< B<-na> >+ >>> S<<< [B<-c> >] >>> [B<-no>] [B<-l>] [B<-f>] [B<-a>] [B<-h>] + [B<-e>] S<<< [B<-co> >] >>> =for html @@ -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 diff --git a/doc/man-pages/pod1/pts_interactive.pod.in b/doc/man-pages/pod1/pts_interactive.pod.in index c1aa51a..a0338da 100644 --- a/doc/man-pages/pod1/pts_interactive.pod.in +++ b/doc/man-pages/pod1/pts_interactive.pod.in @@ -8,9 +8,12 @@ pts_interactive - Enters interactive mode
B S<<< [B<-cell>] > >>> [B<-noauth>] - [B<-auth>] [B<-localauth>] [B<-force>] + [B<-auth>] [B<-localauth>] [B<-force>] [B<-help>] + [B<-encrypt>] S<<< [B<-config> >] >>> -B S<<< [B<-c>] > >>> [B<-n>] [B<-f>] + +B S<<< [B<-c>] > >>> [B<-n>] [B<-f>] [B<-h>] + [B<-a>] [B<-e>] S<<< [B<-co> >] >>> =for html
diff --git a/doc/man-pages/pod1/pts_listentries.pod.in b/doc/man-pages/pod1/pts_listentries.pod.in index e2e663b..321b052 100644 --- a/doc/man-pages/pod1/pts_listentries.pod.in +++ b/doc/man-pages/pod1/pts_listentries.pod.in @@ -9,9 +9,10 @@ pts_listentries - Displays all users or groups in the Protection Database B [B<-users>] [B<-groups>] S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] [B<-force>] [B<-help>] + [B<-auth>] [B<-encrypt>] S<<< [B<-config> >] >>> B [B<-u>] [B<-g>] S<<< [B<-c> >] >>> [B<-n>] [B<-l>] - [B<-f>] [B<-h>] + [B<-f>] [B<-h>] [B<-a>] [B<-e>] S<<< [B<-co> >] >>> =for html diff --git a/doc/man-pages/pod1/pts_listmax.pod.in b/doc/man-pages/pod1/pts_listmax.pod.in index 790face..aee5729 100644 --- a/doc/man-pages/pod1/pts_listmax.pod.in +++ b/doc/man-pages/pod1/pts_listmax.pod.in @@ -8,9 +8,11 @@ pts_listmax - Displays the max user id and max group id counters
B S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] - [B<-force>] [B<-help>] + [B<-force>] [B<-help>] [B<-auth>] [B<-encrypt>] + S<<< [B<-config> >] >>> B S<<< [B<-c> >] >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>] + [B<-a>] [B<-e>] S<<< [B<-co> >] >>> =for html
diff --git a/doc/man-pages/pod1/pts_listowned.pod.in b/doc/man-pages/pod1/pts_listowned.pod.in index c04ddec..9b0c2cf 100644 --- a/doc/man-pages/pod1/pts_listowned.pod.in +++ b/doc/man-pages/pod1/pts_listowned.pod.in @@ -9,9 +9,11 @@ pts_listowned - Show the Protection Database groups owned by a user or group B S<<< B<-nameorid> >+ >>> [-cell >] [B<-noauth>] [B<-localauth>] [B<-force>] [B<-help>] + [B<-auth>] [B<-encrypt>] S<<< [B<-config> >] >>> B S<<< B<-na> >+ >>> [-c >] [B<-no>] [B<-l>] [B<-f>] [B<-h>] + [B<-a>] [B<-e>] S<<< [B<-co> >] >>> =for html diff --git a/doc/man-pages/pod1/pts_membership.pod.in b/doc/man-pages/pod1/pts_membership.pod.in index c70e24e..b124baf 100644 --- a/doc/man-pages/pod1/pts_membership.pod.in +++ b/doc/man-pages/pod1/pts_membership.pod.in @@ -10,18 +10,22 @@ pts_membership - Displays the membership list for a user or group B S<<< B<-nameorid> >+ >>> [B<-supergroups>] [B<-expandgroups>] S<<< [B<-cell> >] >>> [B<-localauth>] [B<-noauth>] [B<-force>] [B<-help>] + [B<-auth>] [B<-encrypt>] S<<< [B<-config> >] >>> B S<<< B<-na> >+ >>> [B<-s>] [B<-ex>] S<<< [B<-c> >] >>> [B<-no>] [B<-l>] [B<-f>] [B<-h>] + [B<-a>] [B<-en>] S<<< [B<-co> >] >>> B S<<< B<-na> >+ >>> [B<-s>] [B<-ex>] S<<< [B<-c> >] >>> [B<-no>] [B<-l>] [B<-f>] [B<-h>] + [B<-a>] [B<-en>] S<<< [B<-co> >] >>> B S<<< B<-na> >+ >>> [B<-s>] [B<-ex>] S<<< [B<-c> >] >>> [B<-no>] [B<-l>] [B<-f>] [B<-h>] + [B<-a>] [B<-en>] S<<< [B<-co> >] >>> =for html diff --git a/doc/man-pages/pod1/pts_quit.pod.in b/doc/man-pages/pod1/pts_quit.pod.in index d742ec9..0fbf780 100644 --- a/doc/man-pages/pod1/pts_quit.pod.in +++ b/doc/man-pages/pod1/pts_quit.pod.in @@ -8,9 +8,11 @@ pts_quit - Exit from pts interactive mode
B S<<< [B<-cell>] > >>> [B<-noauth>] [B<-localauth>] - [B<-force>] + [B<-force>] [B<-help>] [B<-auth>] [B<-encrypt>] + S<<< [B<-config> >] >>> -B S<<< [B<-c>] > >>> [B<-n>] [B<-l>] [B<-f>] +B S<<< [B<-c>] > >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>] + [B<-a>] [B<-e>] S<<< [B<-co> >] >>> =for html
diff --git a/doc/man-pages/pod1/pts_removeuser.pod.in b/doc/man-pages/pod1/pts_removeuser.pod.in index 4dcf213..d0a02b9 100644 --- a/doc/man-pages/pod1/pts_removeuser.pod.in +++ b/doc/man-pages/pod1/pts_removeuser.pod.in @@ -9,10 +9,11 @@ pts_removeuser - Removes a user from a Protection Database group B S<<< B<-user> >+ >>> S<<< B<-group> >+ >>> S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] [B<-force>] - [B<-help>] + [B<-help>] [B<-auth>] [B<-encrypt>] S<<< [B<-config> >] >>> B S<<< B<-u> >+ >>> S<<< B<-g> >+ >>> S<<< [B<-c> >] >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>] + [B<-a>] [B<-e>] S<<< [B<-co> >] >>> =for html @@ -38,7 +39,7 @@ tokens or reauthenticate. =over 4 -=item B<-name> >+ +=item B<-user> >+ Specifies the name of each user entry or the IP address (complete or wildcard-style) of each machine entry to remove. diff --git a/doc/man-pages/pod1/pts_rename.pod.in b/doc/man-pages/pod1/pts_rename.pod.in index 775feec..8245296 100644 --- a/doc/man-pages/pod1/pts_rename.pod.in +++ b/doc/man-pages/pod1/pts_rename.pod.in @@ -9,10 +9,12 @@ pts_rename - Changes the name of a Protection Database entry B S<<< B<-oldname> > >>> S<<< B<-newname> > >>> S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] - [B<-force>] [B<-help>] + [B<-force>] [B<-help>] [B<-auth>] [B<-encrypt>] + S<<< [B<-config> >] >>> B S<<< B<-o> > >>> S<<< B<-ne> > >>> S<<< [B<-c> >] >>> - [B<-no>] [B<-l>] [B<-f>] [B<-h>] + [B<-no>] [B<-l>] [B<-f>] [B<-h>] [B<-a>] [B<-e>] + S<<< [B<-co> >] >>> =for html diff --git a/doc/man-pages/pod1/pts_setfields.pod.in b/doc/man-pages/pod1/pts_setfields.pod.in index b6c9d19..a914454 100644 --- a/doc/man-pages/pod1/pts_setfields.pod.in +++ b/doc/man-pages/pod1/pts_setfields.pod.in @@ -11,12 +11,14 @@ B S<<< B<-nameorid> >+ >>> S<<< [B<-access> >] >>> S<<< [B<-groupquota> >] >>> S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] - [B<-force>] [B<-help>] + [B<-force>] [B<-help>] [B<-auth>] [B<-encrypt>] + S<<< [B<-config> >] >>> B S<<< B<-na> >+ >>> - S<<< [B<-a> >] >>> + S<<< [B<-ac> >] >>> S<<< [B<-g> >] >>> S<<< [B<-c> >] >>> - [B<-no>] [B<-l>] [B<-f>] [B<-h>] + [B<-no>] [B<-l>] [B<-f>] [B<-h>] [B<-au>] [B<-e>] + S<<< [B<-co> >] >>> =for html diff --git a/doc/man-pages/pod1/pts_setmax.pod.in b/doc/man-pages/pod1/pts_setmax.pod.in index 1bfca5e..d9fe75a 100644 --- a/doc/man-pages/pod1/pts_setmax.pod.in +++ b/doc/man-pages/pod1/pts_setmax.pod.in @@ -9,9 +9,11 @@ pts_setmax - Sets the value of the max group id or max user id counter B S<<< [B<-group> >] >>> S<<< [B<-user> >] >>> S<<< [B<-cell> >] >>> [B<-noauth>] [B<-localauth>] [B<-force>] [B<-help>] + [B<-auth>] [B<-encrypt>] S<<< [B<-config> >] >>> B [B<-g> I>] S<<< [B<-u> >] >>> S<<< [B<-c> >] >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>] + [B<-a>] [B<-e>] S<<< [B<-co> >] >>> =for html diff --git a/doc/man-pages/pod1/pts_sleep.pod.in b/doc/man-pages/pod1/pts_sleep.pod.in index f59d271..3e7c135 100644 --- a/doc/man-pages/pod1/pts_sleep.pod.in +++ b/doc/man-pages/pod1/pts_sleep.pod.in @@ -9,9 +9,11 @@ pts_sleep - Pauses for a few seconds B S<<< [B<-delay>] > >>> S<<< [B<-cell>] > >>> [B<-noauth>] [B<-localauth>] [B<-force>] + [B<-help>] [B<-auth>] [B<-encrypt>] S<<< [B<-config> >] >>> B S<<< [B<-d>] > >>> S<<< [B<-c>] > >>> - [B<-n>] [B<-l>] [B<-f>] + [B<-n>] [B<-l>] [B<-f>] [B<-h>] + [B<-a>] [B<-e>] S<<< [B<-co> >] >>> =for html @@ -38,6 +40,10 @@ B options: =over 4 +=item B<-delay> > + +Specifies the amount of time to sleep, in seconds. + =include fragments/pts-common.pod =back diff --git a/doc/man-pages/pod1/pts_source.pod.in b/doc/man-pages/pod1/pts_source.pod.in index 3179815..24da00d 100644 --- a/doc/man-pages/pod1/pts_source.pod.in +++ b/doc/man-pages/pod1/pts_source.pod.in @@ -8,10 +8,11 @@ pts_source - Read pts commands from a file
B S<<< [B<-file>] > >>> S<<< [B<-cell>] > >>> - [B<-noauth>] [B<-localauth>] [B<-force>] + [B<-noauth>] [B<-localauth>] [B<-force>] [B<-auth>] [B<-encrypt>] [B<-help>] + S<<< [B<-config> >] >>> B S<<< [B<-f>] > >>> S<<< [B<-c>] > >>> - [B<-n>] [B<-l>] [B<-f>] + [B<-n>] [B<-l>] [B<-f>] [B<-h>] [B<-a>] [B<-e>] S<<< [B<-co> >] >>> =for html
@@ -35,6 +36,11 @@ B takes the following options: =over 4 +=item B<-file> > + +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 -- 1.9.4