From 2a1737ec2ba5ba917c7d5afded2972be1bf096cb Mon Sep 17 00:00:00 2001 From: Russ Allbery Date: Wed, 15 Mar 2006 05:06:50 +0000 Subject: [PATCH] * Include xstat_cm_test and xstat_fs_test in openafs-client, as they're quite useful for debugging. --- debian/changelog | 2 + debian/doc/pod1/xstat_cm_test.pod | 117 ++++++++++++++++++++++++++++++ debian/doc/pod1/xstat_fs_test.pod | 113 +++++++++++++++++++++++++++++ debian/openafs-client.install | 4 + 4 files changed, 236 insertions(+) create mode 100644 debian/doc/pod1/xstat_cm_test.pod create mode 100644 debian/doc/pod1/xstat_fs_test.pod diff --git a/debian/changelog b/debian/changelog index b8f167235..c91a70704 100644 --- a/debian/changelog +++ b/debian/changelog @@ -5,6 +5,8 @@ openafs (1.4.0-4) unstable; urgency=low * Document the need to restart ptserver and vlserver on the existing database servers when adding a new one. Thanks, Niklas Edmundsson. (Closes: #349659) + * Include xstat_cm_test and xstat_fs_test in openafs-client, as they're + quite useful for debugging. -- diff --git a/debian/doc/pod1/xstat_cm_test.pod b/debian/doc/pod1/xstat_cm_test.pod new file mode 100644 index 000000000..59431333a --- /dev/null +++ b/debian/doc/pod1/xstat_cm_test.pod @@ -0,0 +1,117 @@ +=head1 NAME + +xstat_cm_test - Displays data collections from the Cache Manager + +=head1 SYNOPSIS + +=for html +
+ +B [I] + S<<< B<-cmname> >+ >>> + S<<< B<-collID> >+ >>> [B<-onceonly>] + S<<< [B<-frequency> >] >>> + S<<< [B<-period> >] >>> [B<-debug>] + [B<-help>] + +B [I] S<<< B<-cm> >+ >>> + S<<< B<-co> >+ >>> [B<-o>] + S<<< [B<-f> >] >>> + S<<< [B<-p> >] >>> [B<-d>] [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command tests the routines in the F +library and displays the data collections associated with the Cache +Manager. 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 + +Accommodates the command's use of the AFS command parser, and is optional. + +=item B<-cmname> >+ + +Specifies the fully qualified hostname of each client machine for which to +monitor the Cache Manager. + +=item B<-collID> >+ + +Specifies each data collection to return, which defines the type and +amount of data the command interpreter gathers about the Cache Manager. +Data is returned in a predefined data structure. + +There are three acceptable values: + +=over 4 + +=item 0 + +Provides profiling information about the numbers of times different +internal Cache Manager routines were called since the Cache Manager +started. + +=item 1 + +Reports various internal performance statistics related to the Cache +Manager (for example, statistics about how effectively the cache is being +used and the quantity of intracell and intercell data access). + +=item 2 + +Reports all of the internal performance statistics provided by the C<1> +setting, plus some additional, detailed performance figures (for example, +statistics about the number of RPCs sent by the Cache Manager and how long +they take to complete, and statistics regarding authentication, access, +and PAG information associated with data access). + +=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> > + +Sets the frequency in seconds at which the program initiates probes to the +Cache Manager. The default is 30 seconds. + +=item B<-period> > + +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 + +=head1 COPYRIGHT + +IBM Corporation 2000. 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. diff --git a/debian/doc/pod1/xstat_fs_test.pod b/debian/doc/pod1/xstat_fs_test.pod new file mode 100644 index 000000000..05684343f --- /dev/null +++ b/debian/doc/pod1/xstat_fs_test.pod @@ -0,0 +1,113 @@ +=head1 NAME + +xstat_fs_test - Displays data collections from the File Server process + +=head1 SYNOPSIS + +=for html +
+ +B [I] S<<< B<-fsname> >+ >>> + S<<< B<-collID> >+ >>> [B<-onceonly>] + S<<< [B<-frequency> >] >>> + S<<< [B<-period> >] >>> [B<-debug>] [B<-help>] + +B [B] S<<< B<-fs> >+ >>> + S<<< B<-c> >+ >>> [B<-o>] + S<<< [B<-fr> >] >>> + S<<< [B<-p> >] >>> [B<-d>] [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command tests the routines in the F +library and displays the data collections associated with the File Server +(the C 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 + +Accommodates the command's use of the AFS command parser, and is optional. + +=item B<-fsname> >+ + +Specifies the fully qualified hostname of each file server machine for +which to monitor the File Server process. + +=item B<-collID> >+ + +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. + +There are three acceptable values: + +=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> > + +Sets the frequency in seconds at which the program initiates probes to the +Cache Manager. The default is 30 seconds. + +=item B<-period> > + +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 + +=head1 COPYRIGHT + +IBM Corporation 2000. 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. diff --git a/debian/openafs-client.install b/debian/openafs-client.install index e6eb68da4..52428d465 100644 --- a/debian/openafs-client.install +++ b/debian/openafs-client.install @@ -15,6 +15,8 @@ debian/tmp/usr/bin/translate_et usr/bin debian/tmp/usr/bin/udebug usr/bin debian/tmp/usr/bin/unlog usr/bin debian/tmp/usr/bin/up usr/bin +debian/tmp/usr/bin/xstat_cm_test usr/bin +debian/tmp/usr/bin/xstat_fs_test usr/bin debian/tmp/usr/sbin/rxdebug usr/bin debian/tmp/usr/sbin/vos usr/bin @@ -159,6 +161,8 @@ debian/doc/man1/vos_syncvldb.1 usr/share/man/man1 debian/doc/man1/vos_unlock.1 usr/share/man/man1 debian/doc/man1/vos_unlockvldb.1 usr/share/man/man1 debian/doc/man1/vos_zap.1 usr/share/man/man1 +debian/doc/man1/xstat_cm_test.1 usr/share/man/man1 +debian/doc/man1/xstat_fs_test.1 usr/share/man/man1 debian/doc/man5/CellServDB.5 usr/share/man/man5 debian/doc/man5/NetInfo.5 usr/share/man/man5 -- 2.39.5