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

   1 =head1 NAME
   2
   3 fssync-debug, dafssync-debug - Introduction to the fssync-debug command suite
   4
   5 =head1 DESCRIPTION
   6
   7 The B<fssync-debug> command suite allows low-level inspection and control
   8 of the file server volume packages.  The B<dafssync-debug> command suite
   9 is identical to B<fssync-debug>, but is built with demand-attach support.
  10
  11 This command suite operates at an extremely low-level and hence requires
  12 detailed knowledge of the OpenAFS architecture and code.  An understanding
  13 of the OpenAFS volume finite-state machine is required before the state of
  14 a volume should be manipulated.  Indiscriminate use of B<fssync-debug> or
  15 B<dafssync-debug> in control mode can lead to extremely bad things
  16 occurring. Use with care.
  17
  18 =head1 OPTIONS
  19
  20 The following arguments and flags are available on many commands in the
  21 B<fssync-debug> suite. The reference page for each command also lists them,
  22 but they may be described here in greater detail.
  23
  24 =over 4
  25
  26 =item B<-volumeid> <I<volume ID>>
  27
  28 Specifies the numeric volume ID. Volume names are not permitted.
  29
  30 =item B<-partition> <I<exact partition name>>
  31
  32 Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
  33 are not permitted.
  34
  35 =item B<-reason> <I<sync protocol reason code>>
  36
  37 Specifies numeric sync protocol reason code.
  38 Available codes are listed in OpenAFS source file
  39 F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
  40 use B<-reason I<0>>.
  41
  42 =item B<-programtype> <I<program type code>>
  43
  44 Specifies program type code. Permitted values are
  45 I<fileServer>,
  46 I<volumeUtility>,
  47 I<salvager>,
  48 I<salvageServer>,
  49 I<volumeServer> and
  50 I<volumeSalvager>.
  51
  52 =back
  53
  54 =head1 PRIVILEGE REQUIRED
  55
  56 The issuer must have write access to the file server.
  57 Usually, this means that the issuer must be the
  58 local superuser C<root> on the file server machine.
  59
  60 =head1 SEE ALSO
  61
  62 L<fssync-debug_apropos(8)>,
  63 L<fssync-debug_attach(8)>,
  64 L<fssync-debug_callback(8)>,
  65 L<fssync-debug_detach(8)>,
  66 L<fssync-debug_error(8)>,
  67 L<fssync-debug_header(8)>,
  68 L<fssync-debug_help(8)>,
  69 L<fssync-debug_leaveoff(8)>,
  70 L<fssync-debug_list(8)>,
  71 L<fssync-debug_mode(8)>,
  72 L<fssync-debug_move(8)>,
  73 L<fssync-debug_offline(8)>,
  74 L<fssync-debug_online(8)>,
  75 L<fssync-debug_query(8)>,
  76 L<fssync-debug_stats(8)>,
  77 L<fssync-debug_vgcadd(8)>,
  78 L<fssync-debug_vgcdel(8)>,
  79 L<fssync-debug_vgcquery(8)>,
  80 L<fssync-debug_vgcscan(8)>,
  81 L<fssync-debug_vgcscanall(8)>,
  82 L<fssync-debug_vnode(8)>,
  83 L<fssync-debug_volop(8)>
  84
  85 =head1 COPYRIGHT
  86
  87 Copyright 2010 Davor Ocelic <docelic@spinlocksolutions.com>
  88
  89 This documentation is covered by the IBM Public License Version 1.0.  This
  90 man page was written by Davor Ocelic for OpenAFS, based on documentation
  91 from Steven Jenkins, Tom Keiser and Simon Wilkinson.