doc: document the version subcommand
authorMichael Meffie <mmeffie@sinenomine.net>
Wed, 21 May 2014 21:27:47 +0000 (17:27 -0400)
committerBenjamin Kaduk <kaduk@mit.edu>
Thu, 12 Nov 2015 16:29:37 +0000 (11:29 -0500)
Document the built-in version sub-command which displays
the OpenAFS version string. This sub-command is provided
by the cmd library.

Document the switch style -version option provided by the cmd
library for the initcmd based commands: afsmonitor, scout,
xstat_fs_test, and xstat_cm_test.

Change-Id: Id421d2c68a5c49a2b1a5abb2f3e9ca64ea36cd3e
Reviewed-on: http://gerrit.openafs.org/11161
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
Tested-by: BuildBot <buildbot@rampaginggeek.com>

doc/man-pages/pod1/afsmonitor.pod
doc/man-pages/pod1/fs.pod
doc/man-pages/pod1/pts.pod
doc/man-pages/pod1/scout.pod
doc/man-pages/pod1/xstat_cm_test.pod
doc/man-pages/pod1/xstat_fs_test.pod
doc/man-pages/pod5/afsmonitor.pod
doc/man-pages/pod8/backup.pod
doc/man-pages/pod8/bos.pod
doc/man-pages/pod8/kas.pod

index 127f217..67bcc37 100644 (file)
@@ -13,7 +13,7 @@ B<afsmonitor> [B<initcmd>] [-config <I<configuration file>>]
     S<<< [B<-debug> <I<debug output file>>] >>>
     S<<< [B<-fshosts> <I<list of file servers to monitor>>+] >>>
     S<<< [B<-cmhosts> <I<list of cache managers to monitor>>+] >>>
-    S<<< [B<-buffers> <I<number of buffer slots>>] >>> [B<-help>]
+    S<<< [B<-buffers> <I<number of buffer slots>>] >>> [B<-version>] [B<-help>]
 
 B<afsmonitor> [B<i>]  [-co <I<configuration file>>]
     S<<< [B<-fr> <I<poll frequency, in seconds>>] >>>
@@ -21,7 +21,7 @@ B<afsmonitor> [B<i>]  [-co <I<configuration file>>]
     S<<< [B<-deb> <I<debug output file>>] >>>
     S<<< [B<-fs> <I<list of file servers to monitor>>+] >>>
     S<<< [B<-cm> <I<list of cache managers to monitor>>+] >>>
-    S<<< [B<-b> <I<number of buffer slots>>] >>> [B<-h>]
+    S<<< [B<-b> <I<number of buffer slots>>] >>> [B<-version>] [B<-h>]
 
 =for html
 </div>
@@ -173,6 +173,11 @@ file.
 Prints the online help for this command. All other valid options are
 ignored.
 
+=item B<-version>
+
+Prints the program version and then exits. All other valid options
+are ignored.
+
 =back
 
 =head1 OUTPUT
index e9887be..695277b 100644 (file)
@@ -101,6 +101,10 @@ Commands to obtain help:
 L<B<fs apropos>|fs_apropos(1)>
 and L<B<fs help>|fs_help(1)>.
 
+=item *
+
+A command to display the OpenAFS command suite version: B<fs version>.
+
 =back
 
 The Cache Manager and the fs commands use and maintain the following
index f3417ba..d3a890b 100644 (file)
@@ -79,6 +79,10 @@ Commands to obtain help:
 L<B<pts apropos>|pts_apropos(1)>
 and L<B<pts help>|pts_help(1)>.
 
+=item *
+
+A command to display the OpenAFS command suite version: B<pts version>.
+
 =back
 
 =head1 OPTIONS
index 3a63b1a..6704ba4 100644 (file)
@@ -13,13 +13,13 @@ B<scout> [B<initcmd>] S<<< B<-server> <I<servers to monitor>>+ >>>
       S<<< [B<-attention> <I<specify attention (highlighting) level>>+] >>>
       S<<< [B<-columnwidths> <I<number of characters>>+] >>>
       S<<< [B<-debug> <I<turn debugging output on to the named file>>] >>>
-      [B<-help>]
+      [B<-version>] [B<-help>]
 
 B<scout> [B<i>] S<<< B<-s> <I<servers to monitor>>+ >>>
       S<<< [B<-b> <I<base server name>>] >>> S<<< [B<-f> <I<poll frequency, in seconds>>] >>>
       [B<-ho>] S<<< [B<-a> <I<specify attention (highlighting) level>>+] >>>
       S<<< [B<-c> <I<number of characters>+>] >>>
-      S<<< [B<-d> <I<turn debugging output on to the named file>>] >>> [B<-he>]
+      S<<< [B<-d> <I<turn debugging output on to the named file>>] >>> [B<-version>] [B<-he>]
 
 =for html
 </div>
@@ -176,6 +176,11 @@ directory.
 Prints the online help for this command. All other valid options are
 ignored.
 
+=item B<-version>
+
+Prints the program version and then exits. All other valid options
+are ignored.
+
 =back
 
 =head1 OUTPUT
index 06d67af..aaf886c 100644 (file)
@@ -12,12 +12,12 @@ B<xstat_cm_test> [I<initcmd>]
     S<<< B<-collID> <I<collection(s) to fetch>>+ >>> [B<-onceonly>]
     S<<< [B<-frequency> <I<poll frequency, in seconds>>] >>>
     S<<< [B<-period> <I<data collection time, in minutes>>] >>> [B<-debug>]
-    [B<-help>]
+    [B<-version>] [B<-help>]
 
 B<xstat_cm_test> [I<i>] S<<< B<-cm> <I<cache manager name(s) to monitor>>+ >>>
     S<<< B<-co> <I<collection(s) to fetch>>+ >>> [B<-o>]
     S<<< [B<-f> <I<poll frequency, in seconds>>] >>>
-    S<<< [B<-p> <I<data collection time, in minutes>>] >>> [B<-d>] [B<-h>]
+    S<<< [B<-p> <I<data collection time, in minutes>>] >>> [B<-d>] [B<-version>] [B<-h>]
 
 =for html
 </div>
@@ -102,6 +102,11 @@ Displays a trace on the standard output stream as the command runs.
 Prints the online help for this command. All other valid options are
 ignored.
 
+=item B<-version>
+
+Prints the program version and then exits. All other valid options
+are ignored.
+
 =back
 
 =head1 SEE ALSO
index 7c2257d..b405cb7 100644 (file)
@@ -10,12 +10,12 @@ xstat_fs_test - Displays data collections from the File Server process
 B<xstat_fs_test> [I<initcmd>] S<<< B<-fsname> <I<file server name(s) to monitor>>+ >>>
     S<<< B<-collID> <I<collection(s) to fetch>>+ >>> [B<-onceonly>]
     S<<< [B<-frequency> <I<poll frequency, in seconds>>] >>>
-    S<<< [B<-period> <I<data collection time, in minutes>>] >>> [B<-debug>] [B<-help>]
+    S<<< [B<-period> <I<data collection time, in minutes>>] >>> [B<-debug>] [B<-version>] [B<-help>]
 
 B<xstat_fs_test> [B<initcmd>] S<<< B<-fs> <I<File Server name(s) to monitor>>+ >>>
     S<<< B<-c> <I<Collection(s) to fetch>>+ >>> [B<-o>]
     S<<< [B<-fr> <I<poll frequency, in seconds>>] >>>
-    S<<< [B<-p> <I<data collection time, in minutes>>] >>> [B<-d>] [B<-h>]
+    S<<< [B<-p> <I<data collection time, in minutes>>] >>> [B<-d>] [B<-version>] [B<-h>]
 
 =for html
 </div>
@@ -105,6 +105,11 @@ Displays a trace on the standard output stream as the command runs.
 Prints the online help for this command. All other valid options are
 ignored.
 
+=item B<-version>
+
+Prints the program version and then exits. All other valid options
+are ignored.
+
 =back
 
 =head1 SEE ALSO
index fff6263..f5e0a60 100644 (file)
@@ -97,6 +97,10 @@ Precedes a line of text that the afsmonitor program ignores because of the
 initial number (C<#>) sign, which must appear in the very first column of
 the line.
 
+=item B<version>
+
+Print the OpenAFS command suite version and then exit.
+
 =back
 
 For a list of the values that can appear in the I<field/group/section>
index 139ff23..f8e2ebc 100644 (file)
@@ -72,6 +72,10 @@ Commands to obtain help:
 L<B<backup apropos>|backup_apropos(8)>
 and L<B<backup help>|backup_help(8)>.
 
+=item *
+
+A command to display the OpenAFS command suite version: B<backup version>.
+
 =back
 
 The backup command interpreter interacts with two other processes:
index 7cb3284..70f9126 100644 (file)
@@ -47,6 +47,10 @@ A command to restore file system consistency: B<bos salvage>.
 
 Commands to obtain help: B<bos apropos> and B<bos help>.
 
+=item *
+
+A command to display the OpenAFS command suite version: B<bos version>.
+
 =back
 
 The BOS Server and the B<bos> commands use and maintain the following
index 43eb1d0..afeb12d 100644 (file)
@@ -53,6 +53,10 @@ Commands to obtain help:
 L<B<kas apropos>|kas_apropos(8)>
 and L<B<kas help>|kas_help(8)>.
 
+=item *
+
+A command to display the OpenAFS command suite version: B<kas version>.
+
 =back
 
 Because of the sensitivity of information in the Authentication Database,