jimzah/openafs
1
0
Fork 0
mirror of https://git.openafs.org/openafs.git synced 2025-01-19 15:30:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
85bb464bb4
openafs/doc/man-pages/pod1/xstat_fs_test.pod

114 lines
3.3 KiB
Plaintext
Raw Normal View History

man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
=head1 NAME
xstat_fs_test - Displays data collections from the File Server process
=head1 SYNOPSIS
pretty-html-synopsis-20060228 Implement proper synopsis wrapping for HTML generation. This was done in three pieces. First, add HTML-specific tags to the POD to mark the synopsis for HTML purposes so that we can apply style information to it. Second, update the style sheet to indent all lines except for the first in the synopsis section. Third, add the appropriate S<> tags around option and argument pairs so that we don't wrap between the option and its argument. Unfortunately, due to the <I<foo>> style that looks nicer for other reasons, we have to use the very verbose S<<< >>>. Oh well.
2006-03-01 05:02:29 +00:00
=for html
<div class="synopsis">
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>]
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>]
=for html
</div>
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
=head1 DESCRIPTION
The B<xstat_fs_test> command tests the routines in the F<libxstat_fs.a>
library and displays the data collections associated with the File Server
(the C<fs> process). The command executes in the foreground.
The command produces a large volume of output; to save it for later
analysis, direct it to a file.
=head1 OPTIONS
=over 4
=item I<initcmd>
Accommodates the command's use of the AFS command parser, and is optional.
=item B<-fsname> <I<file server name to monitor>>+
Specifies the fully qualified hostname of each file server machine for
which to monitor the File Server process.
=item B<-collID> <I<collection to fetch>>+
Specifies each data collection to return, which defines the type and
amount of data the command interpreter gathers about the File Server.
Data is returned in a predefined data structure.
man-page-whitespace-20051220 Remove all trailing whitespace while we have the chance and there are no merge issues yet.
2005-12-21 00:41:17 +00:00
There are three acceptable values:
man8-editing-pass-20051213 This completes the initial editing pass of the section eight man pages. Only small amounts of content editing has been done. Some known problems have been noted in README, but there will doubtless be others, as well as some lingering formatting problems. However, the quality should now be good enough for general public review. Some of the section eight man pages were really supposed to be section one, the package apropros and package help commands are too useless to document, and a few of the difficult-to-name section five man pages have now acquired names.
2005-12-13 19:21:13 +00:00
=over 4
=item 0
Provides profiling information about the numbers of times different
internal File Server routines were called since the File Server
started. This value is not currently implemented; it returns no data.
=item 1
Reports various internal performance statistics related to the File Server
(for example, vnode cache entries and Rx protocol activity).
=item 2
Reports all of the internal performance statistics provided by the C<1>
setting, plus some additional, detailed performance figures about the File
Server (for example, minimum, maximum, and cumulative statistics regarding
File Server RPCs, how long they take to complete, and how many succeed).
=back
=item B<-onceonly>
Gathers statistics just one time. Omit this flag to have the command
continue to probe the Cache Manager for statistics at the frequency
specified by the B<-frequency> argument; in this case press Ctrl-C to stop
the probes.
=item B<-frequency> <I<poll frequency>>
Sets the frequency in seconds at which the program initiates probes to the
Cache Manager. The default is 30 seconds.
=item B<-period> <I<data collection time>>
Sets the number of minutes the program runs; at the end of this period of
time, the program exits. The default is 10 minutes.
=item B<-debug>
Displays a trace on the standard output stream as the command runs.
=item B<-help>
Prints the online help for this command. All other valid options are
ignored.
=back
=head1 SEE ALSO
L<xstat_cm_test(1)>
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
This documentation is covered by the IBM Public License Version 1.0. It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.
Reference in New Issue Copy Permalink