From: Davor Ocelic Date: Sun, 20 Jun 2010 13:38:14 +0000 (+0200) Subject: Provide manpage for fssync-debug and most subcmds X-Git-Tag: openafs-devel-1_5_75~92 X-Git-Url: https://git.openafs.org/?p=openafs.git;a=commitdiff_plain;h=8c633162b98f4aebd3449684574f8a35c9e0fa58 Provide manpage for fssync-debug and most subcmds This is another patch in the series to provide manpages for dafs-related commands. Most (if not all) documentation is coming from source documentation and DAFS articles/presentations. The primary motivation behind this is to comply with Debian guidelines requiring all binaries to have respective manpages. This patch has been sitting here for months, so it's good time to finally submit it. Note that fssync-debug also supports some vcg* commands, for which I was not able to find any documentation I could use. So, they are still left to be documented. Change-Id: I9d067766e2a90b26646edc87f15a4f533c5c8d44 Reviewed-on: http://gerrit.openafs.org/2220 Reviewed-by: Russ Allbery Tested-by: Russ Allbery --- diff --git a/doc/man-pages/pod8/fssync-debug.pod b/doc/man-pages/pod8/fssync-debug.pod new file mode 100644 index 0000000..dcc1c8c --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug.pod @@ -0,0 +1,92 @@ +=head1 NAME + +fssync-debug - Introduction to the fssync-debug command suite + +=head1 DESCRIPTION + +B command suite allows low-level inspection and +control of the file server volume packages. + +This command suite is only supported on the demand-attach file server. +It operates at an extremely low-level and hence requires detailed +knowledge of the OpenAFS architecture and code. + +An understanding of the OpenAFS volume finite-state machine is +required before the state of a volume should be manipulated. +Indiscriminate use of B in control mode can lead to +extremely bad things occurring. Use with care. + +=head1 OPTIONS + +The following arguments and flags are available on many commands in the +B suite. The reference page for each command also lists them, +but they may be described here in greater detail. + +=over 4 + +=item B<-volumeid> > + +Specifies the numeric volume ID. Volume names are not permitted. + +=item B<-partition> > + +Specifies the exact partition name (e.g. I). Abbreviations +are not permitted. + +=item B<-reason> > + +Specifies numeric sync protocol reason code. +Available codes are listed in OpenAFS source file +F. For SYNC_REASON_NONE, +use B<-reason I<0>>. + +=item B<-programtype> > + +Specifies program type code. Permitted values are +I, +I, +I, +I, +I and +I. + +=back + +=head1 PRIVILEGE REQUIRED + +The issuer must have write access to the file server. +Usually, this means that the issuer must be the +local superuser C on the file server machine. + +=head1 SEE ALSO + +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2010 Davor Ocelic + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Davor Ocelic for OpenAFS, based on documentation +from Steven Jenkins, Tom Keiser and Simon Wilkinson. diff --git a/doc/man-pages/pod8/fssync-debug_attach.pod b/doc/man-pages/pod8/fssync-debug_attach.pod new file mode 100644 index 0000000..3aeeb2f --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_attach.pod @@ -0,0 +1,82 @@ +=head1 NAME + +fssync-debug_attach - Forces full volume attachment (FSYNC_VOL_ATTACH opcode) + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-volumeid> > >>> + S<<< [B<-partition> >] >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command forces full attachment of +a volume. + +=head1 OPTIONS + +=over 4 + +=item B<-volumeid> > + +Specifies the numeric volume ID. Volume names are not permitted. + +=item B<-partition> > + +Specifies the exact partition name (e.g. I). Abbreviations +are not permitted. + +=item B<-reason> > + +Specifies numeric sync protocol reason code. +Available codes are listed in OpenAFS source file +F. For SYNC_REASON_NONE, +use B<-reason I<0>>. + +=item B<-programtype> > + +Specifies program type code. Permitted values are +I, +I, +I, +I, +I and +I. + +=back + +=head1 PRIVILEGE REQUIRED + +The issuer must have write access to the file server. +Usually, this means that the issuer must be the +local superuser C on the file server machine. + +=head1 SEE ALSO + +L, +L, +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2010 Davor Ocelic + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Davor Ocelic for OpenAFS, based on documentation +from Steven Jenkins, Tom Keiser and Simon Wilkinson. diff --git a/doc/man-pages/pod8/fssync-debug_callback.pod b/doc/man-pages/pod8/fssync-debug_callback.pod new file mode 100644 index 0000000..0f5457a --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_callback.pod @@ -0,0 +1,88 @@ +=head1 NAME + +fssync-debug_callback - Breaks callbacks for a volume (FSYNC_VOL_BREAKCBKS opcode) + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-volumeid> > >>> + S<<< [B<-partition> >] >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command breaks callbacks for a volume. + +=head1 OPTIONS + +=over 4 + +=item B<-volumeid> > + +Specifies the numeric volume ID. Volume names are not permitted. + +=item B<-partition> > + +Specifies the exact partition name (e.g. I). Abbreviations +are not permitted. + +=item B<-reason> > + +Specifies numeric sync protocol reason code. +Available codes are listed in OpenAFS source file +F. For SYNC_REASON_NONE, +use B<-reason I<0>>. + +=item B<-programtype> > + +Specifies program type code. Permitted values are +I, +I, +I, +I, +I and +I. + +=back + +=head1 PRIVILEGE REQUIRED + +The issuer must have write access to the file server. +Usually, this means that the issuer must be the +local superuser C on the file server machine. + +=head1 SEE ALSO + +L, +L, +L, +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2010 Davor Ocelic + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Davor Ocelic for OpenAFS, based on documentation +from Steven Jenkins, Tom Keiser and Simon Wilkinson. diff --git a/doc/man-pages/pod8/fssync-debug_detach.pod b/doc/man-pages/pod8/fssync-debug_detach.pod new file mode 100644 index 0000000..3f3a6f0 --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_detach.pod @@ -0,0 +1,81 @@ +=head1 NAME + +fssync-debug_detach - Detaches a volume (FSYNC_VOL_DONE opcode) + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-volumeid> > >>> + S<<< [B<-partition> >] >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command detaches a volume. + +=head1 OPTIONS + +=over 4 + +=item B<-volumeid> > + +Specifies the numeric volume ID. Volume names are not permitted. + +=item B<-partition> > + +Specifies the exact partition name (e.g. I). Abbreviations +are not permitted. + +=item B<-reason> > + +Specifies numeric sync protocol reason code. +Available codes are listed in OpenAFS source file +F. For SYNC_REASON_NONE, +use B<-reason I<0>>. + +=item B<-programtype> > + +Specifies program type code. Permitted values are +I, +I, +I, +I, +I and +I. + +=back + +=head1 PRIVILEGE REQUIRED + +The issuer must have write access to the file server. +Usually, this means that the issuer must be the +local superuser C on the file server machine. + +=head1 SEE ALSO + +L, +L, +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2010 Davor Ocelic + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Davor Ocelic for OpenAFS, based on documentation +from Steven Jenkins, Tom Keiser and Simon Wilkinson. diff --git a/doc/man-pages/pod8/fssync-debug_error.pod b/doc/man-pages/pod8/fssync-debug_error.pod new file mode 100644 index 0000000..569237f --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_error.pod @@ -0,0 +1,83 @@ +=head1 NAME + +fssync-debug_error - Forces volume into hard error state (FSYNC_VOL_FORCE_ERROR opcode) + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-volumeid> > >>> + S<<< [B<-partition> >] >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command forces a volume into +hard error state. + +=head1 OPTIONS + +=over 4 + +=item B<-volumeid> > + +Specifies the numeric volume ID. Volume names are not permitted. + +=item B<-partition> > + +Specifies the exact partition name (e.g. I). Abbreviations +are not permitted. + +=item B<-reason> > + +Specifies numeric sync protocol reason code. +Available codes are listed in OpenAFS source file +F. For SYNC_REASON_NONE, +use B<-reason I<0>>. + +=item B<-programtype> > + +Specifies program type code. Permitted values are +I, +I, +I, +I, +I and +I. + +=back + +=head1 PRIVILEGE REQUIRED + +The issuer must have write access to the file server. +Usually, this means that the issuer must be the +local superuser C on the file server machine. + +=head1 SEE ALSO + +L, +L, +L, +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2010 Davor Ocelic + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Davor Ocelic for OpenAFS, based on documentation +from Steven Jenkins, Tom Keiser and Simon Wilkinson. diff --git a/doc/man-pages/pod8/fssync-debug_header.pod b/doc/man-pages/pod8/fssync-debug_header.pod new file mode 100644 index 0000000..64fe6a5 --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_header.pod @@ -0,0 +1,85 @@ +=head1 NAME + +fssync-debug_header - Retrieves volume disk data structure (FSYNC_VOL_QUERY_HDR opcode) + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-volumeid> > >>> + S<<< [B<-partition> >] >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command retrieves volume disk +data structure. + +=head1 OPTIONS + +=over 4 + +=item B<-volumeid> > + +Specifies the numeric volume ID. Volume names are not permitted. + +=item B<-partition> > + +Specifies the exact partition name (e.g. I). Abbreviations +are not permitted. + +=item B<-reason> > + +Specifies numeric sync protocol reason code. +Available codes are listed in OpenAFS source file +F. For SYNC_REASON_NONE, +use B<-reason I<0>>. + +=item B<-programtype> > + +Specifies program type code. Permitted values are +I, +I, +I, +I, +I and +I. + +=back + +=head1 PRIVILEGE REQUIRED + +The issuer must have write access to the file server. +Usually, this means that the issuer must be the +local superuser C on the file server machine. + +=head1 SEE ALSO + +L, +L + +=head1 COPYRIGHT + +Copyright 2010 Davor Ocelic + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Davor Ocelic for OpenAFS, based on documentation +from Steven Jenkins, Tom Keiser and Simon Wilkinson. diff --git a/doc/man-pages/pod8/fssync-debug_leaveoff.pod b/doc/man-pages/pod8/fssync-debug_leaveoff.pod new file mode 100644 index 0000000..321024b --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_leaveoff.pod @@ -0,0 +1,81 @@ +=head1 NAME + +fssync-debug_leaveoff - Leaves a volume offline (FSYNC_VOL_LEAVE_OFF opcode) + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-volumeid> > >>> + S<<< [B<-partition> >] >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command leaves a volume offline. + +=head1 OPTIONS + +=over 4 + +=item B<-volumeid> > + +Specifies the numeric volume ID. Volume names are not permitted. + +=item B<-partition> > + +Specifies the exact partition name (e.g. I). Abbreviations +are not permitted. + +=item B<-reason> > + +Specifies numeric sync protocol reason code. +Available codes are listed in OpenAFS source file +F. For SYNC_REASON_NONE, +use B<-reason I<0>>. + +=item B<-programtype> > + +Specifies program type code. Permitted values are +I, +I, +I, +I, +I and +I. + +=back + +=head1 PRIVILEGE REQUIRED + +The issuer must have write access to the file server. +Usually, this means that the issuer must be the +local superuser C on the file server machine. + +=head1 SEE ALSO + +L, +L, +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2010 Davor Ocelic + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Davor Ocelic for OpenAFS, based on documentation +from Steven Jenkins, Tom Keiser and Simon Wilkinson. diff --git a/doc/man-pages/pod8/fssync-debug_list.pod b/doc/man-pages/pod8/fssync-debug_list.pod new file mode 100644 index 0000000..f65e925 --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_list.pod @@ -0,0 +1,86 @@ +=head1 NAME + +fssync-debug_list - Historical sync command (FSYNC_VOL_LISTVOLUMES opcode) + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-volumeid> > >>> + S<<< [B<-partition> >] >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B does nothing but return success, assuming +the fileserver is available. The opcode it calls exists for +historical reasons, and now does nothing. + +=head1 OPTIONS + +=over 4 + +=item B<-volumeid> > + +Specifies the numeric volume ID. Volume names are not permitted. + +=item B<-partition> > + +Specifies the exact partition name (e.g. I). Abbreviations +are not permitted. + +=item B<-reason> > + +Specifies numeric sync protocol reason code. +Available codes are listed in OpenAFS source file +F. For SYNC_REASON_NONE, +use B<-reason I<0>>. + +=item B<-programtype> > + +Specifies program type code. Permitted values are +I, +I, +I, +I, +I and +I. + +=back + +=head1 PRIVILEGE REQUIRED + +The issuer must have write access to the file server. +Usually, this means that the issuer must be the +local superuser C on the file server machine. + +=head1 SEE ALSO + +L, +L + +=head1 COPYRIGHT + +Copyright 2010 Davor Ocelic + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Davor Ocelic for OpenAFS, based on documentation +from Steven Jenkins, Tom Keiser and Simon Wilkinson. diff --git a/doc/man-pages/pod8/fssync-debug_mode.pod b/doc/man-pages/pod8/fssync-debug_mode.pod new file mode 100644 index 0000000..59bd4b7 --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_mode.pod @@ -0,0 +1,94 @@ +=head1 NAME + +fssync-debug_mode - Changes volume attach mode (FSYNC_VOL_NEEDVOLUME opcode) + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-volumeid> > >>> + S<<< [B<-partition> >] >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command changes volume attach mode. + +=head1 OPTIONS + +=over 4 + +=item B<-volumeid> > + +Specifies the numeric volume ID. Volume names are not permitted. + +=item B<-partition> > + +Specifies the exact partition name (e.g. I). Abbreviations +are not permitted. + +=item B<-reason> > + +Specifies numeric sync protocol reason code. +Available codes are listed in OpenAFS source file +F. For SYNC_REASON_NONE, +use B<-reason I<0>>. + +=item B<-programtype> > + +Specifies program type code. Permitted values are +I, +I, +I, +I, +I and +I. + +=back + +=head1 PRIVILEGE REQUIRED + +The issuer must have write access to the file server. +Usually, this means that the issuer must be the +local superuser C on the file server machine. + +=head1 SEE ALSO + +L, +L, +L, +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2010 Davor Ocelic + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Davor Ocelic for OpenAFS, based on documentation +from Steven Jenkins, Tom Keiser and Simon Wilkinson. diff --git a/doc/man-pages/pod8/fssync-debug_move.pod b/doc/man-pages/pod8/fssync-debug_move.pod new file mode 100644 index 0000000..6acd295 --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_move.pod @@ -0,0 +1,81 @@ +=head1 NAME + +fssync-debug_move - Sets volume moved flag (FSYNC_VOL_MOVE opcode) + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-volumeid> > >>> + S<<< [B<-partition> >] >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command sets volume moved flag. + +=head1 OPTIONS + +=over 4 + +=item B<-volumeid> > + +Specifies the numeric volume ID. Volume names are not permitted. + +=item B<-partition> > + +Specifies the exact partition name (e.g. I). Abbreviations +are not permitted. + +=item B<-reason> > + +Specifies numeric sync protocol reason code. +Available codes are listed in OpenAFS source file +F. For SYNC_REASON_NONE, +use B<-reason I<0>>. + +=item B<-programtype> > + +Specifies program type code. Permitted values are +I, +I, +I, +I, +I and +I. + +=back + +=head1 PRIVILEGE REQUIRED + +The issuer must have write access to the file server. +Usually, this means that the issuer must be the +local superuser C on the file server machine. + +=head1 SEE ALSO + +L, +L, +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2010 Davor Ocelic + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Davor Ocelic for OpenAFS, based on documentation +from Steven Jenkins, Tom Keiser and Simon Wilkinson. diff --git a/doc/man-pages/pod8/fssync-debug_offline.pod b/doc/man-pages/pod8/fssync-debug_offline.pod new file mode 100644 index 0000000..c9d2695 --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_offline.pod @@ -0,0 +1,82 @@ +=head1 NAME + +fssync-debug_offline - Brings a volume offline (FSYNC_VOL_OFF opcode) + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-volumeid> > >>> + S<<< [B<-partition> >] >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command brings a volume offline. + +=head1 OPTIONS + +=over 4 + +=item B<-volumeid> > + +Specifies the numeric volume ID. Volume names are not permitted. + +=item B<-partition> > + +Specifies the exact partition name (e.g. I). Abbreviations +are not permitted. + +=item B<-reason> > + +Specifies numeric sync protocol reason code. +Available codes are listed in OpenAFS source file +F. For SYNC_REASON_NONE, +use B<-reason I<0>>. + +=item B<-programtype> > + +Specifies program type code. Permitted values are +I, +I, +I, +I, +I and +I. + +=back + +=head1 PRIVILEGE REQUIRED + +The issuer must have write access to the file server. +Usually, this means that the issuer must be the +local superuser C on the file server machine. + +=head1 SEE ALSO + +L, +L, +L, +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2010 Davor Ocelic + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Davor Ocelic for OpenAFS, based on documentation +from Steven Jenkins, Tom Keiser and Simon Wilkinson. diff --git a/doc/man-pages/pod8/fssync-debug_online.pod b/doc/man-pages/pod8/fssync-debug_online.pod new file mode 100644 index 0000000..b9589de --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_online.pod @@ -0,0 +1,82 @@ +=head1 NAME + +fssync-debug_online - Brings a volume online (FSYNC_VOL_ON opcode) + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-volumeid> > >>> + S<<< [B<-partition> >] >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command brings a volume online. + +=head1 OPTIONS + +=over 4 + +=item B<-volumeid> > + +Specifies the numeric volume ID. Volume names are not permitted. + +=item B<-partition> > + +Specifies the exact partition name (e.g. I). Abbreviations +are not permitted. + +=item B<-reason> > + +Specifies numeric sync protocol reason code. +Available codes are listed in OpenAFS source file +F. For SYNC_REASON_NONE, +use B<-reason I<0>>. + +=item B<-programtype> > + +Specifies program type code. Permitted values are +I, +I, +I, +I, +I and +I. + +=back + +=head1 PRIVILEGE REQUIRED + +The issuer must have write access to the file server. +Usually, this means that the issuer must be the +local superuser C on the file server machine. + +=head1 SEE ALSO + +L, +L, +L, +L, +L, +L + +=head1 COPYRIGHT + +Copyright 2010 Davor Ocelic + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Davor Ocelic for OpenAFS, based on documentation +from Steven Jenkins, Tom Keiser and Simon Wilkinson. diff --git a/doc/man-pages/pod8/fssync-debug_query.pod b/doc/man-pages/pod8/fssync-debug_query.pod new file mode 100644 index 0000000..3a24497 --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_query.pod @@ -0,0 +1,84 @@ +=head1 NAME + +fssync-debug_query - Displays volume structure (FSYNC_VOL_QUERY opcode) + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-volumeid> > >>> + S<<< [B<-partition> >] >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +B S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command displays volume structure. + +=head1 OPTIONS + +=over 4 + +=item B<-volumeid> > + +Specifies the numeric volume ID. Volume names are not permitted. + +=item B<-partition> > + +Specifies the exact partition name (e.g. I). Abbreviations +are not permitted. + +=item B<-reason> > + +Specifies numeric sync protocol reason code. +Available codes are listed in OpenAFS source file +F. For SYNC_REASON_NONE, +use B<-reason I<0>>. + +=item B<-programtype> > + +Specifies program type code. Permitted values are +I, +I, +I, +I, +I and +I. + +=back + +=head1 PRIVILEGE REQUIRED + +The issuer must have write access to the file server. +Usually, this means that the issuer must be the +local superuser C on the file server machine. + +=head1 SEE ALSO + +L, +L + +=head1 COPYRIGHT + +Copyright 2010 Davor Ocelic + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Davor Ocelic for OpenAFS, based on documentation +from Steven Jenkins, Tom Keiser and Simon Wilkinson. diff --git a/doc/man-pages/pod8/fssync-debug_stats.pod b/doc/man-pages/pod8/fssync-debug_stats.pod new file mode 100644 index 0000000..efc24ad --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_stats.pod @@ -0,0 +1,118 @@ +=head1 NAME + +fssync-debug_stats - Displays various statistics + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-cmd> > >>> + S<<< [B<-arg1> >] >>> + S<<< [B<-arg2> >] >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B S<<< B<-c> > >>> + S<<< [B<-arg1> >] >>> + S<<< [B<-arg2> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-p> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command displays statistics +according to the value of the option B<-cmd>. + +=head1 OPTIONS + +=over 4 + +=item B<-cmd> > + +Specifies statistics subcommand. Available subcommands are: + +=over 4 + +=item * + +B -- general volume package statistics + +=item * + +B -- vice partition statistics + +=item * + +B -- volume hash chain statistics + +=item * + +B -- volume header cache statistics + +=item * + +B -- vlru generation statistics + +=item * + +B -- display list of available subcommands + +=back + +=item B<-arg1> > + +Specifies first optional argument, in the context of the +chosen subcommand. For I statistics, it specifies +partition name; for I statistics, it specifies +hash bucket number; for I statistics it specifies +vlru generation number. + +=item B<-arg2> > + +Specifies second optional argument, in the context of +the chose subcommand. Currently, none of the subcommands +use it. + +=item B<-reason> > + +Specifies numeric sync protocol reason code. +Available codes are listed in OpenAFS source file +F. For SYNC_REASON_NONE, +use B<-reason I<0>>. + +=item B<-programtype> > + +Specifies program type code. Permitted values are +I, +I, +I, +I, +I and +I. + +=back + +=head1 PRIVILEGE REQUIRED + +The issuer must have write access to the file server. +Usually, this means that the issuer must be the +local superuser C on the file server machine. + +=head1 SEE ALSO + +L, +L + +=head1 COPYRIGHT + +Copyright 2010 Davor Ocelic + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Davor Ocelic for OpenAFS, based on documentation +from Steven Jenkins, Tom Keiser and Simon Wilkinson.