From 87049b873b08ddd2246c02cd66099940eae2b1fd Mon Sep 17 00:00:00 2001 From: Jeffrey Altman Date: Sun, 29 Jan 2012 16:46:22 -0500 Subject: [PATCH] man-pages: add fs_getverify and fs_setverify 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 Reviewed-by: Jeffrey Altman --- doc/man-pages/NTMakefile | 2 + doc/man-pages/pod1/fs.pod | 4 ++ doc/man-pages/pod1/fs_getverify.pod | 69 +++++++++++++++++++++++ doc/man-pages/pod1/fs_setverify.pod | 87 +++++++++++++++++++++++++++++ 4 files changed, 162 insertions(+) create mode 100644 doc/man-pages/pod1/fs_getverify.pod create mode 100644 doc/man-pages/pod1/fs_setverify.pod diff --git a/doc/man-pages/NTMakefile b/doc/man-pages/NTMakefile index dccb065fa..38c12c5ea 100644 --- a/doc/man-pages/NTMakefile +++ b/doc/man-pages/NTMakefile @@ -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 \ diff --git a/doc/man-pages/pod1/fs.pod b/doc/man-pages/pod1/fs.pod index 654faf3cd..b6fb65205 100644 --- a/doc/man-pages/pod1/fs.pod +++ b/doc/man-pages/pod1/fs.pod @@ -21,12 +21,14 @@ L|fs_checkservers(1)>, L|fs_getcellstatus(1)>, L|fs_getcrypt(1)>, L|fs_getserverprefs(1)>, +L|fs_getverify(1)>, L|fs_listcells(1)>, L|fs_newcell(1)>, L|fs_setcbaddr(1)>, L|fs_setcell(1)>, L|fs_setcrypt(1)>, L|fs_setserverprefs(1)>, +L|fs_setverify(1)>, L|fs_sysname(1)>, L|fs_uuid(1)>, and L|fs_wscell(1)>. @@ -208,6 +210,7 @@ L, L, L, L, +L, L, L, L, @@ -233,6 +236,7 @@ L, L, L, L, +L, L, L, L, diff --git a/doc/man-pages/pod1/fs_getverify.pod b/doc/man-pages/pod1/fs_getverify.pod new file mode 100644 index 000000000..68b88c7f2 --- /dev/null +++ b/doc/man-pages/pod1/fs_getverify.pod @@ -0,0 +1,69 @@ +=head1 NAME + +fs_getverify - Displays the state of data verification for AFS store operations [Windows only] + +=head1 SYNOPSIS + +=for html +
+ +B [B<-help>] + +=for html +
+ +=head1 DESCRIPTION + +The B 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 which sets the status of data verification in the client. + +=head1 CAUTIONS + +The B 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 + +=head1 PRIVILEGE REQUIRED + +No special priviledges are required for this command. + +=head1 SEE ALSO + +L + +=head1 COPYRIGHT + +Copyright 2012 Jeffrey Altman + +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 index 000000000..5784b73cd --- /dev/null +++ b/doc/man-pages/pod1/fs_setverify.pod @@ -0,0 +1,87 @@ +=head1 NAME + +fs_setverify - Enables or disables data verification for AFS store data operations [Windows only] + +=head1 SYNOPSIS + +=for html +
+ +B S<<< [B<-verify>] > >>> [B<-help>] + +=for html +
+ +=head1 DESCRIPTION + +The B 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, 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 command is only available on Microsoft Windows. There +is no equivalent for other platforms. + +=head1 OPTIONS + +=over 4 + +=item B<-verify> > + +This is the only option to B. The B<-verify> option takes +either C or C. C enables data verification. C disables +data verification. Since this is the only option, the C<-verify> flag may be +omitted. + +C<0> and C<1> or C and C are not supported as replacements +for C and C. + +=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. 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 + +=head1 COPYRIGHT + +Copyright 2012 Jeffrey Altman + +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. -- 2.39.5