Provide man pages for more fssync-debug commands
authorAndrew Deason <adeason@sinenomine.net>
Wed, 23 Jun 2010 21:08:13 +0000 (16:08 -0500)
committerDerrick Brashear <shadow@dementia.org>
Mon, 12 Jul 2010 18:53:41 +0000 (11:53 -0700)
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 <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>

doc/man-pages/pod8/fssync-debug_vgcadd.pod [new file with mode: 0644]
doc/man-pages/pod8/fssync-debug_vgcdel.pod [new file with mode: 0644]
doc/man-pages/pod8/fssync-debug_vgcquery.pod [new file with mode: 0644]
doc/man-pages/pod8/fssync-debug_vgcscan.pod [new file with mode: 0644]
doc/man-pages/pod8/fssync-debug_vgcscanall.pod [new file with mode: 0644]
doc/man-pages/pod8/fssync-debug_vnode.pod [new file with mode: 0644]
doc/man-pages/pod8/fssync-debug_volop.pod [new file with mode: 0644]

diff --git a/doc/man-pages/pod8/fssync-debug_vgcadd.pod b/doc/man-pages/pod8/fssync-debug_vgcadd.pod
new file mode 100644 (file)
index 0000000..8bef986
--- /dev/null
@@ -0,0 +1,88 @@
+=head1 NAME
+
+fssync-debug_vgcadd - Add an entry to the VG cache (FSYNC_VG_UPDATE opcode)
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fssync-debug vgcadd>
+    S<<< B<-partition> <I<exact partition name>> >>>
+    S<<< B<-parent> <I<volume ID>> >>>
+    S<<< B<-child> <I<volume ID>> >>>
+    S<<< [B<-reason> <I<sync protocol reason code>>] >>>
+    S<<< [B<-programtype> <I<program type code>>] >>>
+    [B<-help>]
+
+B<fssync-debug vgca>
+    S<<< B<-part> <I<exact partition name>> >>>
+    S<<< B<-pare> <I<volume ID>> >>>
+    S<<< B<-c> <I<volume ID>> >>>
+    S<<< [B<-r> <I<sync protocol reason code>>] >>>
+    S<<< [B<-pr> <I<program type code>>] >>>
+    [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<fssync-debug vgcadd> command adds an entry to the volume group
+cache (VGC).
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-partition> <I<exact partition name>>
+
+Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
+are not permitted.
+
+=item B<-parent> <I<volume ID>>
+
+Specifies the numeric volume ID for the parent volume of the VGC entry.
+
+=item B<-child> <I<volume ID>>
+
+Specifies the numeric volume ID for the child volume in the VGC entry.
+
+=item B<-reason> <I<sync protocol reason code>>
+
+Specifies numeric sync protocol reason code.
+Available codes are listed in OpenAFS source file
+F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
+use B<-reason I<0>>.
+
+=item B<-programtype> <I<program type code>>
+
+Specifies program type code. Permitted values are
+I<fileServer>,
+I<volumeUtility>,
+I<salvager>,
+I<salvageServer>,
+I<volumeServer> and
+I<volumeSalvager>.
+
+=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<root> on the file server machine.
+
+=head1 SEE ALSO
+
+L<fssync-debug_vgcdel(8)>,
+L<fssync-debug_vgcquery(8)>,
+L<fssync-debug_vgcscan(8)>,
+L<fssync-debug_vgcscanall(8)>,
+
+=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 (file)
index 0000000..fa47331
--- /dev/null
@@ -0,0 +1,89 @@
+=head1 NAME
+
+fssync-debug_vgcdel - Delete an entry from the VG cache (FSYNC_VG_UPDATE opcode)
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fssync-debug vgcdel>
+    S<<< B<-partition> <I<exact partition name>> >>>
+    S<<< B<-parent> <I<volume ID>> >>>
+    S<<< B<-child> <I<volume ID>> >>>
+    S<<< [B<-reason> <I<sync protocol reason code>>] >>>
+    S<<< [B<-programtype> <I<program type code>>] >>>
+    [B<-help>]
+
+B<fssync-debug vgcd>
+    S<<< B<-part> <I<exact partition name>> >>>
+    S<<< B<-pare> <I<volume ID>> >>>
+    S<<< B<-c> <I<volume ID>> >>>
+    S<<< [B<-r> <I<sync protocol reason code>>] >>>
+    S<<< [B<-pr> <I<program type code>>] >>>
+    [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<fssync-debug vgcdel> command deletes an entry from the volume
+group cache (VGC).
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-partition> <I<exact partition name>>
+
+Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
+are not permitted.
+
+=item B<-parent> <I<volume ID>>
+
+Specifies the numeric volume ID for the parent volume of the VGC entry.
+
+=item B<-child> <I<volume ID>>
+
+Specifies the numeric volume ID for the child volume in the VGC entry
+to delete.
+
+=item B<-reason> <I<sync protocol reason code>>
+
+Specifies numeric sync protocol reason code.
+Available codes are listed in OpenAFS source file
+F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
+use B<-reason I<0>>.
+
+=item B<-programtype> <I<program type code>>
+
+Specifies program type code. Permitted values are
+I<fileServer>,
+I<volumeUtility>,
+I<salvager>,
+I<salvageServer>,
+I<volumeServer> and
+I<volumeSalvager>.
+
+=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<root> on the file server machine.
+
+=head1 SEE ALSO
+
+L<fssync-debug_vgcadd(8)>,
+L<fssync-debug_vgcquery(8)>,
+L<fssync-debug_vgcscan(8)>,
+L<fssync-debug_vgcscanall(8)>,
+
+=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 (file)
index 0000000..2a3e7db
--- /dev/null
@@ -0,0 +1,89 @@
+=head1 NAME
+
+fssync-debug_vgcquery - Displays VG cache contents (FSYNC_VG_QUERY opcode)
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fssync-debug vgcquery>
+    S<<< B<-partition> <I<exact partition name>> >>>
+    S<<< B<-volumeid> <I<volume ID>> >>>
+    S<<< [B<-reason> <I<sync protocol reason code>>] >>>
+    S<<< [B<-programtype> <I<program type code>>] >>>
+    [B<-help>]
+
+B<fssync-debug vgcq>
+    S<<< B<-pa> <I<exact partition name>> >>>
+    S<<< B<-v> <I<volume ID>> >>>
+    S<<< [B<-r> <I<sync protocol reason code>>] >>>
+    S<<< [B<-pr> <I<program type code>>] >>>
+    [B<-h>]
+
+B<fssync-debug vgcqry>
+    S<<< B<-pa> <I<exact partition name>> >>>
+    S<<< B<-v> <I<volume ID>> >>>
+    S<<< [B<-r> <I<sync protocol reason code>>] >>>
+    S<<< [B<-pr> <I<program type code>>] >>>
+    [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<fssync-debug vgcquery> 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> <I<exact partition name>>
+
+Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
+are not permitted.
+
+=item B<-volumeid> <I<volume ID>>
+
+Specifies the numeric volume ID. Volume names are not permitted.
+
+=item B<-reason> <I<sync protocol reason code>>
+
+Specifies numeric sync protocol reason code.
+Available codes are listed in OpenAFS source file
+F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
+use B<-reason I<0>>.
+
+=item B<-programtype> <I<program type code>>
+
+Specifies program type code. Permitted values are
+I<fileServer>,
+I<volumeUtility>,
+I<salvager>,
+I<salvageServer>,
+I<volumeServer> and
+I<volumeSalvager>.
+
+=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<root> on the file server machine.
+
+=head1 SEE ALSO
+
+L<fssync-debug_vgcadd(8)>,
+L<fssync-debug_vgcdel(8)>,
+L<fssync-debug_vgcscan(8)>,
+L<fssync-debug_vgcscanall(8)>,
+
+=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 (file)
index 0000000..d29817f
--- /dev/null
@@ -0,0 +1,76 @@
+=head1 NAME
+
+fssync-debug_vgcscan - Force a VG cache rescan (FSYNC_VG_SCAN opcode)
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fssync-debug vgcscan>
+    S<<< B<-partition> <I<exact partition name>> >>>
+    S<<< [B<-reason> <I<sync protocol reason code>>] >>>
+    S<<< [B<-programtype> <I<program type code>>] >>>
+    [B<-help>]
+
+B<fssync-debug vgcscan>
+    S<<< B<-pa> <I<exact partition name>> >>>
+    S<<< [B<-r> <I<sync protocol reason code>>] >>>
+    S<<< [B<-pr> <I<program type code>>] >>>
+    [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<fssync-debug vgcscan> command forces a rescan of the volume group
+cache (VGC) for a particular partition.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-partition> <I<exact partition name>>
+
+Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
+are not permitted.
+
+=item B<-reason> <I<sync protocol reason code>>
+
+Specifies numeric sync protocol reason code.
+Available codes are listed in OpenAFS source file
+F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
+use B<-reason I<0>>.
+
+=item B<-programtype> <I<program type code>>
+
+Specifies program type code. Permitted values are
+I<fileServer>,
+I<volumeUtility>,
+I<salvager>,
+I<salvageServer>,
+I<volumeServer> and
+I<volumeSalvager>.
+
+=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<root> on the file server machine.
+
+=head1 SEE ALSO
+
+L<fssync-debug_vgcadd(8)>,
+L<fssync-debug_vgcdel(8)>,
+L<fssync-debug_vgcquery(8)>,
+L<fssync-debug_vgcscanall(8)>,
+
+=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 (file)
index 0000000..67328a4
--- /dev/null
@@ -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
+<div class="synopsis">
+
+B<fssync-debug vgcscanall>
+    S<<< [B<-reason> <I<sync protocol reason code>>] >>>
+    S<<< [B<-programtype> <I<program type code>>] >>>
+    [B<-help>]
+
+B<fssync-debug vgcscana>
+    S<<< [B<-r> <I<sync protocol reason code>>] >>>
+    S<<< [B<-pr> <I<program type code>>] >>>
+    [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<fssync-debug vgcscanall> command forces a rescan of the volume
+group cache (VGC) for all partitions attached by the fileserver.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-reason> <I<sync protocol reason code>>
+
+Specifies numeric sync protocol reason code.
+Available codes are listed in OpenAFS source file
+F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
+use B<-reason I<0>>.
+
+=item B<-programtype> <I<program type code>>
+
+Specifies program type code. Permitted values are
+I<fileServer>,
+I<volumeUtility>,
+I<salvager>,
+I<salvageServer>,
+I<volumeServer> and
+I<volumeSalvager>.
+
+=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<root> on the file server machine.
+
+=head1 SEE ALSO
+
+L<fssync-debug_vgcadd(8)>,
+L<fssync-debug_vgcdel(8)>,
+L<fssync-debug_vgcquery(8)>,
+L<fssync-debug_vgcscan(8)>,
+
+=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 (file)
index 0000000..c5d3933
--- /dev/null
@@ -0,0 +1,89 @@
+=head1 NAME
+
+fssync-debug_vnode - Display vnode info (FSYNC_VOL_QUERY_VNODE opcode)
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fssync-debug vnode> S<<< B<-volumeid> <I<volume ID>> >>>
+    S<<< B<-vnodeid> <I<vnode ID>> >>>
+    S<<< B<-unique> <I<uniquifier>> >>>
+    S<<< B<-partition> <I<exact partition name>> >>>
+    S<<< [B<-reason> <I<sync protocol reason code>>] >>>
+    S<<< [B<-programtype> <I<program type code>>] >>>
+    [B<-help>]
+
+B<fssync-debug vn> S<<< B<-vo> <I<volume ID>> >>>
+    S<<< B<-vn> <I<vnode ID>> >>>
+    S<<< B<-u> <I<uniquifier>> >>>
+    S<<< B<-pa> <I<exact partition name>> >>>
+    S<<< [B<-r> <I<sync protocol reason code>>] >>>
+    S<<< [B<-pr> <I<program type code>>] >>>
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<fssync-debug vnode> command displays information about a given
+vnode.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-volumeid> <I<volume ID>>
+
+Specifies the numeric volume ID. Volume names are not permitted.
+
+=item B<-vnodeid> <I<vnode ID>>
+
+Specifies the numeric vnode ID.
+
+=item B<-unique> <I<uniquifier>>
+
+Specifies the numeric vnode uniquifier.
+
+=item B<-partition> <I<exact partition name>>
+
+Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
+are not permitted.
+
+=item B<-reason> <I<sync protocol reason code>>
+
+Specifies numeric sync protocol reason code.
+Available codes are listed in OpenAFS source file
+F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
+use B<-reason I<0>>.
+
+=item B<-programtype> <I<program type code>>
+
+Specifies program type code. Permitted values are
+I<fileServer>,
+I<volumeUtility>,
+I<salvager>,
+I<salvageServer>,
+I<volumeServer> and
+I<volumeSalvager>.
+
+=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<root> on the file server machine.
+
+=head1 SEE ALSO
+
+L<fssync-debug_header(8)>,
+L<fssync-debug_query(8)>,
+
+=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 (file)
index 0000000..c682d28
--- /dev/null
@@ -0,0 +1,88 @@
+=head1 NAME
+
+fssync-debug_volop - Display pending volume operation info (FSYNC_VOL_QUERY_VOP opcode)
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fssync-debug volop> S<<< B<-volumeid> <I<volume ID>> >>>
+    S<<< [B<-partition> <I<exact partition name>>] >>>
+    S<<< [B<-reason> <I<sync protocol reason code>>] >>>
+    S<<< [B<-programtype> <I<program type code>>] >>>
+    [B<-help>]
+
+B<fssync-debug vo> S<<< B<-v> <I<volume ID>> >>>
+    S<<< [B<-pa> <I<exact partition name>>] >>>
+    S<<< [B<-r> <I<sync protocol reason code>>] >>>
+    S<<< [B<-pr> <I<program type code>>] >>>
+
+B<fssync-debug vop> S<<< B<-v> <I<volume ID>> >>>
+    S<<< [B<-pa> <I<exact partition name>>] >>>
+    S<<< [B<-r> <I<sync protocol reason code>>] >>>
+    S<<< [B<-pr> <I<program type code>>] >>>
+    [B<-h>]
+    [B<-h>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<fssync-debug volop> command displays information about the
+pending volume operation for a given volume, if any.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-volumeid> <I<volume ID>>
+
+Specifies the numeric volume ID. Volume names are not permitted.
+
+=item B<-partition> <I<exact partition name>>
+
+Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
+are not permitted.
+
+=item B<-reason> <I<sync protocol reason code>>
+
+Specifies numeric sync protocol reason code.
+Available codes are listed in OpenAFS source file
+F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
+use B<-reason I<0>>.
+
+=item B<-programtype> <I<program type code>>
+
+Specifies program type code. Permitted values are
+I<fileServer>,
+I<volumeUtility>,
+I<salvager>,
+I<salvageServer>,
+I<volumeServer> and
+I<volumeSalvager>.
+
+=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<root> on the file server machine.
+
+=head1 SEE ALSO
+
+L<fssync-debug_attach(8)>,
+L<fssync-debug_detach(8)>,
+L<fssync-debug_mode(8)>,
+L<fssync-debug_online(8)>,
+L<fssync-debug_offline(8)>,
+L<fssync-debug_error(8)>
+
+=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.