doc/man-pages/pod8/fssync-debug_stats.pod

   1 =head1 NAME
   2
   3 fssync-debug_stats - Displays various statistics
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<fssync-debug stats> S<<< B<-cmd> <I<subcommand>> >>>
  11     S<<< [B<-arg1> <I<arg1>>] >>>
  12     S<<< [B<-arg2> <I<arg2>>] >>>
  13     S<<< [B<-reason> <I<sync protocol reason code>>] >>>
  14     S<<< [B<-programtype> <I<program type code>>] >>>
  15     [B<-help>]
  16
  17 B<fssync-debug s> S<<< B<-c> <I<subcommand>> >>>
  18     S<<< [B<-arg1> <I<arg1>>] >>>
  19     S<<< [B<-arg2> <I<arg2>>] >>>
  20     S<<< [B<-r> <I<sync protocol reason code>>] >>>
  21     S<<< [B<-p> <I<program type code>>] >>>
  22     [B<-h>]
  23
  24 =for html
  25 </div>
  26
  27 =head1 DESCRIPTION
  28
  29 The B<fssync-debug stats> command displays statistics
  30 according to the value of the option B<-cmd>.
  31
  32 =head1 OPTIONS
  33
  34 =over 4
  35
  36 =item B<-cmd> <I<subcommand>>
  37
  38 Specifies statistics subcommand. Available subcommands are:
  39
  40 =over 4
  41
  42 =item *
  43
  44 B<pkg>    -- general volume package statistics
  45
  46 =item *
  47
  48 B<vicep>  -- vice partition statistics
  49
  50 =item *
  51
  52 B<hash>   -- volume hash chain statistics
  53
  54 =item *
  55
  56 B<hdr>    -- volume header cache statistics
  57
  58 =item *
  59
  60 B<vlru>   -- vlru generation statistics
  61
  62 =item *
  63
  64 B<help>   -- display list of available subcommands
  65
  66 =back
  67
  68 =item B<-arg1> <I<arg1>>
  69
  70 Specifies first optional argument, in the context of the
  71 chosen subcommand. For I<vicep> statistics, it specifies
  72 partition name; for I<hash> statistics, it specifies
  73 hash bucket number; for I<vlru> statistics it specifies
  74 vlru generation number.
  75
  76 =item B<-arg2> <I<arg2>>
  77
  78 Specifies second optional argument, in the context of
  79 the chose subcommand. Currently, none of the subcommands
  80 use it.
  81
  82 =item B<-reason> <I<sync protocol reason code>>
  83
  84 Specifies numeric sync protocol reason code.
  85 Available codes are listed in OpenAFS source file
  86 F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
  87 use B<-reason I<0>>.
  88
  89 =item B<-programtype> <I<program type code>>
  90
  91 Specifies program type code. Permitted values are
  92 I<fileServer>,
  93 I<volumeUtility>,
  94 I<salvager>,
  95 I<salvageServer>,
  96 I<volumeServer> and
  97 I<volumeSalvager>.
  98
  99 =back
 100
 101 =head1 PRIVILEGE REQUIRED
 102
 103 The issuer must have write access to the file server.
 104 Usually, this means that the issuer must be the
 105 local superuser C<root> on the file server machine.
 106
 107 =head1 SEE ALSO
 108
 109 L<fssync-debug_header(8)>,
 110 L<fssync-debug_query(8)>
 111
 112 =head1 COPYRIGHT
 113
 114 Copyright 2010 Davor Ocelic <docelic@spinlocksolutions.com>
 115
 116 This documentation is covered by the IBM Public License Version 1.0.  This
 117 man page was written by Davor Ocelic for OpenAFS, based on documentation
 118 from Steven Jenkins, Tom Keiser and Simon Wilkinson.