From: Andrew Deason Date: Wed, 23 Jun 2010 21:08:13 +0000 (-0500) Subject: Provide man pages for more fssync-debug commands X-Git-Tag: debian/1.5.75-1~10 X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=168c0470404ecc459ed22aee40db4ae82d98785b;p=packages%2Fo%2Fopenafs.git Provide man pages for more fssync-debug commands Provide man pages for the fssync-debug commands vgcadd, vgcdel, vgcquery, vgcscan, vgcscanall, vnode, and volop. Change-Id: If456a4cdfedbf5f2776c276bc20178319638c26a Reviewed-on: http://gerrit.openafs.org/2239 Reviewed-by: Derrick Brashear Tested-by: Derrick Brashear (cherry picked from commit 5cc6293c2cfc7b0a8746942fd048127bb7cbf10f) --- diff --git a/doc/man-pages/pod8/fssync-debug_vgcadd.pod b/doc/man-pages/pod8/fssync-debug_vgcadd.pod new file mode 100644 index 000000000..8bef98674 --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_vgcadd.pod @@ -0,0 +1,88 @@ +=head1 NAME + +fssync-debug_vgcadd - Add an entry to the VG cache (FSYNC_VG_UPDATE opcode) + +=head1 SYNOPSIS + +=for html +
+ +B + S<<< B<-partition> > >>> + S<<< B<-parent> > >>> + S<<< B<-child> > >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B + S<<< B<-part> > >>> + S<<< B<-pare> > >>> + S<<< B<-c> > >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command adds an entry to the volume group +cache (VGC). + +=head1 OPTIONS + +=over 4 + +=item B<-partition> > + +Specifies the exact partition name (e.g. I). Abbreviations +are not permitted. + +=item B<-parent> > + +Specifies the numeric volume ID for the parent volume of the VGC entry. + +=item B<-child> > + +Specifies the numeric volume ID for the child volume in the VGC entry. + +=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, + +=head1 COPYRIGHT + +Copyright 2010 Sine Nomine Associates + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Andrew Deason and Davor Ocelic for OpenAFS. diff --git a/doc/man-pages/pod8/fssync-debug_vgcdel.pod b/doc/man-pages/pod8/fssync-debug_vgcdel.pod new file mode 100644 index 000000000..fa47331eb --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_vgcdel.pod @@ -0,0 +1,89 @@ +=head1 NAME + +fssync-debug_vgcdel - Delete an entry from the VG cache (FSYNC_VG_UPDATE opcode) + +=head1 SYNOPSIS + +=for html +
+ +B + S<<< B<-partition> > >>> + S<<< B<-parent> > >>> + S<<< B<-child> > >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B + S<<< B<-part> > >>> + S<<< B<-pare> > >>> + S<<< B<-c> > >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command deletes an entry from the volume +group cache (VGC). + +=head1 OPTIONS + +=over 4 + +=item B<-partition> > + +Specifies the exact partition name (e.g. I). Abbreviations +are not permitted. + +=item B<-parent> > + +Specifies the numeric volume ID for the parent volume of the VGC entry. + +=item B<-child> > + +Specifies the numeric volume ID for the child volume in the VGC entry +to delete. + +=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, + +=head1 COPYRIGHT + +Copyright 2010 Sine Nomine Associates + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Andrew Deason and Davor Ocelic for OpenAFS. diff --git a/doc/man-pages/pod8/fssync-debug_vgcquery.pod b/doc/man-pages/pod8/fssync-debug_vgcquery.pod new file mode 100644 index 000000000..2a3e7db8c --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_vgcquery.pod @@ -0,0 +1,89 @@ +=head1 NAME + +fssync-debug_vgcquery - Displays VG cache contents (FSYNC_VG_QUERY opcode) + +=head1 SYNOPSIS + +=for html +
+ +B + S<<< B<-partition> > >>> + S<<< B<-volumeid> > >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B + S<<< B<-pa> > >>> + S<<< B<-v> > >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +B + S<<< B<-pa> > >>> + S<<< B<-v> > >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command displays an entry from the volume +group cache (VGC), and possibly starts a VGC scan if appropriate. + +=head1 OPTIONS + +=over 4 + +=item B<-partition> > + +Specifies the exact partition name (e.g. I). Abbreviations +are not permitted. + +=item B<-volumeid> > + +Specifies the numeric volume ID. Volume names 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, + +=head1 COPYRIGHT + +Copyright 2010 Sine Nomine Associates + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Andrew Deason and Davor Ocelic for OpenAFS. diff --git a/doc/man-pages/pod8/fssync-debug_vgcscan.pod b/doc/man-pages/pod8/fssync-debug_vgcscan.pod new file mode 100644 index 000000000..d29817f95 --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_vgcscan.pod @@ -0,0 +1,76 @@ +=head1 NAME + +fssync-debug_vgcscan - Force a VG cache rescan (FSYNC_VG_SCAN opcode) + +=head1 SYNOPSIS + +=for html +
+ +B + S<<< B<-partition> > >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B + S<<< B<-pa> > >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command forces a rescan of the volume group +cache (VGC) for a particular partition. + +=head1 OPTIONS + +=over 4 + +=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, + +=head1 COPYRIGHT + +Copyright 2010 Sine Nomine Associates + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Andrew Deason and Davor Ocelic for OpenAFS. diff --git a/doc/man-pages/pod8/fssync-debug_vgcscanall.pod b/doc/man-pages/pod8/fssync-debug_vgcscanall.pod new file mode 100644 index 000000000..67328a42d --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_vgcscanall.pod @@ -0,0 +1,69 @@ +=head1 NAME + +fssync-debug_vgcscanall - Force a VG cache rescan on all partitions (FSYNC_VG_SCAN_ALL opcode) + +=head1 SYNOPSIS + +=for html +
+ +B + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command forces a rescan of the volume +group cache (VGC) for all partitions attached by the fileserver. + +=head1 OPTIONS + +=over 4 + +=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, + +=head1 COPYRIGHT + +Copyright 2010 Sine Nomine Associates + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Andrew Deason and Davor Ocelic for OpenAFS. diff --git a/doc/man-pages/pod8/fssync-debug_vnode.pod b/doc/man-pages/pod8/fssync-debug_vnode.pod new file mode 100644 index 000000000..c5d39330f --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_vnode.pod @@ -0,0 +1,89 @@ +=head1 NAME + +fssync-debug_vnode - Display vnode info (FSYNC_VOL_QUERY_VNODE opcode) + +=head1 SYNOPSIS + +=for html +
+ +B S<<< B<-volumeid> > >>> + S<<< B<-vnodeid> > >>> + S<<< B<-unique> > >>> + S<<< B<-partition> > >>> + S<<< [B<-reason> >] >>> + S<<< [B<-programtype> >] >>> + [B<-help>] + +B S<<< B<-vo> > >>> + S<<< B<-vn> > >>> + S<<< B<-u> > >>> + S<<< B<-pa> > >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + +=for html +
+ +=head1 DESCRIPTION + +The B command displays information about a given +vnode. + +=head1 OPTIONS + +=over 4 + +=item B<-volumeid> > + +Specifies the numeric volume ID. Volume names are not permitted. + +=item B<-vnodeid> > + +Specifies the numeric vnode ID. + +=item B<-unique> > + +Specifies the numeric vnode uniquifier. + +=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 Sine Nomine Associates + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Andrew Deason and Davor Ocelic for OpenAFS. diff --git a/doc/man-pages/pod8/fssync-debug_volop.pod b/doc/man-pages/pod8/fssync-debug_volop.pod new file mode 100644 index 000000000..c682d2843 --- /dev/null +++ b/doc/man-pages/pod8/fssync-debug_volop.pod @@ -0,0 +1,88 @@ +=head1 NAME + +fssync-debug_volop - Display pending volume operation info (FSYNC_VOL_QUERY_VOP 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 S<<< B<-v> > >>> + S<<< [B<-pa> >] >>> + S<<< [B<-r> >] >>> + S<<< [B<-pr> >] >>> + [B<-h>] + [B<-h>] + +=for html +
+ +=head1 DESCRIPTION + +The B command displays information about the +pending volume operation for a given volume, if any. + +=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 Sine Nomine Associates + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Andrew Deason and Davor Ocelic for OpenAFS.