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.
Reviewed-on: http://gerrit.openafs.org/11161
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
Tested-by: BuildBot <buildbot@rampaginggeek.com>
(cherry picked from commit
ed52ea68c661a7428baeddeca2d95972fe3fe618)
Change-Id: Ie7a5194b8c407c8899ae71f168dfbaf5b47a3ae5
Reviewed-on: http://gerrit.openafs.org/12096
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Mark Vitale <mvitale@sinenomine.net>
Reviewed-by: Stephan Wiesand <stephan.wiesand@desy.de>
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>>] >>>
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>
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
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
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
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>
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
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>
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
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>
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
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>
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:
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
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,
projects / packages / o / openafs.git / commitdiff