man-pages: add fs_getverify and fs_setverify
authorJeffrey Altman <jaltman@your-file-system.com>
Sun, 29 Jan 2012 21:46:22 +0000 (16:46 -0500)
committerJeffrey Altman <jaltman@secure-endpoints.com>
Sun, 29 Jan 2012 21:54:36 +0000 (13:54 -0800)
Add man pages for two new Windows only commands

  fs getverify
  fs setverify -verify {on, off}

Change-Id: Id784608fba35147a4e33f22e43c7cd50a2307b9e
Reviewed-on: http://gerrit.openafs.org/6632
Tested-by: Jeffrey Altman <jaltman@secure-endpoints.com>
Reviewed-by: Jeffrey Altman <jaltman@secure-endpoints.com>

doc/man-pages/NTMakefile
doc/man-pages/pod1/fs.pod
doc/man-pages/pod1/fs_getverify.pod [new file with mode: 0644]
doc/man-pages/pod1/fs_setverify.pod [new file with mode: 0644]

index dccb065..38c12c5 100644 (file)
@@ -58,6 +58,7 @@ PODS = \
         pod1\fs_getcrypt.pod           \
         pod1\fs_getfid.pod             \
         pod1\fs_getserverprefs.pod     \
+        pod1\fs_getverify.pod          \
         pod1\fs_help.pod               \
         pod1\fs_listacl.pod            \
         pod1\fs_listaliases.pod        \
@@ -83,6 +84,7 @@ PODS = \
         pod1\fs_setcrypt.pod           \
         pod1\fs_setquota.pod           \
         pod1\fs_setserverprefs.pod     \
+        pod1\fs_setverify.pod          \
         pod1\fs_setvol.pod             \
         pod1\fs_storebehind.pod        \
         pod1\fs_sysname.pod            \
index 654faf3..b6fb652 100644 (file)
@@ -21,12 +21,14 @@ L<B<fs checkservers>|fs_checkservers(1)>,
 L<B<fs getcellstatus>|fs_getcellstatus(1)>,
 L<B<fs getcrypt>|fs_getcrypt(1)>,
 L<B<fs getserverprefs>|fs_getserverprefs(1)>,
+L<B<fs getverify>|fs_getverify(1)>,
 L<B<fs listcells>|fs_listcells(1)>,
 L<B<fs newcell>|fs_newcell(1)>,
 L<B<fs setcbaddr>|fs_setcbaddr(1)>,
 L<B<fs setcell>|fs_setcell(1)>,
 L<B<fs setcrypt>|fs_setcrypt(1)>,
 L<B<fs setserverprefs>|fs_setserverprefs(1)>,
+L<B<fs setverify>|fs_setverify(1)>,
 L<B<fs sysname>|fs_sysname(1)>,
 L<B<fs uuid>|fs_uuid(1)>,
 and L<B<fs wscell>|fs_wscell(1)>.
@@ -208,6 +210,7 @@ L<fs_getclientaddrs(1)>,
 L<fs_getcrypt(1)>,
 L<fs_getfid(1)>,
 L<fs_getserverprefs(1)>,
+L<fs_getverify(1)>,
 L<fs_help(1)>,
 L<fs_listacl(1)>,
 L<fs_listaliases(1)>,
@@ -233,6 +236,7 @@ L<fs_setclientaddrs(1)>,
 L<fs_setcrypt(1)>,
 L<fs_setquota(1)>,
 L<fs_setserverprefs(1)>,
+L<fs_setverify(1)>,
 L<fs_setvol(1)>,
 L<fs_storebehind(1)>,
 L<fs_sysname(1)>,
diff --git a/doc/man-pages/pod1/fs_getverify.pod b/doc/man-pages/pod1/fs_getverify.pod
new file mode 100644 (file)
index 0000000..68b88c7
--- /dev/null
@@ -0,0 +1,69 @@
+=head1 NAME
+
+fs_getverify - Displays the state of data verification for AFS store operations [Windows only]
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fs getverify> [B<-help>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<fs getverify> command shows the status of data verification for
+store data operations in the AFS client. When enabled, each store data
+operation is followed by a matching fetch data request.  If the data does
+not match, the operation is repeated. The complement of this command is
+B<fs setverify> which sets the status of data verification in the client.
+
+=head1 CAUTIONS
+
+The B<fs getverify> command is only available on Microsoft Windows.  There
+is no equivalent for other platforms.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-help>
+
+Prints the online help for this command. All other valid options are
+ignored.
+
+=back
+
+=head1 OUTPUT
+
+If data verification is enabled, the output is:
+
+   Data verify mode is currently on.
+
+If data verification is disabled, the output is:
+
+   Data verify mode is currently off.
+
+=head1 EXAMPLES
+
+There is only one way to invoke B<fs getverify>:
+
+   % fs getverify
+
+=head1 PRIVILEGE REQUIRED
+
+No special priviledges are required for this command.
+
+=head1 SEE ALSO
+
+L<fs_setverify(1)>
+
+=head1 COPYRIGHT
+
+Copyright 2012 Jeffrey Altman <jaltman@your-file-system.com>
+
+This documentation is covered by the BSD License as written in the
+doc/LICENSE file. This man page was written by Jeffrey Altman for
+OpenAFS.
diff --git a/doc/man-pages/pod1/fs_setverify.pod b/doc/man-pages/pod1/fs_setverify.pod
new file mode 100644 (file)
index 0000000..5784b73
--- /dev/null
@@ -0,0 +1,87 @@
+=head1 NAME
+
+fs_setverify - Enables or disables data verification for AFS store data operations [Windows only]
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fs setverify> S<<< [B<-verify>] <I<on/off>> >>> [B<-help>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<fs setverify> command sets the status of data verification for
+store data operations in the AFS client. When enabled, each store data
+operation is followed by a matching fetch data request.  If the data does
+not match, the operation is repeated. The complement of this command is
+B<fs getverify>, which shows the status of data verification in the client.
+
+The default data verification status is disabled.
+
+This is a global setting and applies to all subsequent connections to an
+AFS File Server from this Cache Manager. There is no way to enable or
+disable enverifyion for specific connections.
+
+=head1 CAUTIONS
+
+The B<fs setverify> command is only available on Microsoft Windows.  There
+is no equivalent for other platforms.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-verify> <I<on/off>>
+
+This is the only option to B<fs setverify>. The B<-verify> option takes
+either C<on> or C<off>. C<on> enables data verification. C<off> disables
+data verification. Since this is the only option, the C<-verify> flag may be
+omitted.
+
+C<0> and C<1> or C<true> and C<false> are not supported as replacements
+for C<on> and C<off>.
+
+=item B<-help>
+
+Prints the online help for this command. All other valid options are
+ignored.
+
+=back
+
+=head1 OUTPUT
+
+This command produces no output other than error messages.
+
+=head1 EXAMPLES
+
+There are only four ways to invoke B<fs setverify>.  Either of:
+
+   % fs setverify -verify on
+   % fs setverify on
+
+will enable data verification and:
+
+   % fs setverify -verify off
+   % fs setverify off
+
+will disable data verification.
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must be logged in as the local superuser root.
+
+=head1 SEE ALSO
+
+L<fs_getverify(1)>
+
+=head1 COPYRIGHT
+
+Copyright 2012 Jeffrey Altman <jaltman@your-file-system.com>
+
+This documentation is covered by the BSD License as written in the
+doc/LICENSE file. This man page was written by Jeffrey Altman for
+OpenAFS.