Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod1 / fs_setverify.pod
1 =head1 NAME
2
3 fs_setverify - Enables or disables data verification for AFS store data operations [Windows only]
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fs setverify> S<<< [B<-verify>] <I<on/off>> >>> [B<-help>]
11
12 =for html
13 </div>
14
15 =head1 DESCRIPTION
16
17 The B<fs setverify> command sets the status of data verification for
18 store data operations in the AFS client. When enabled, each store data
19 operation is followed by a matching fetch data request. If the data does
20 not match, the operation is repeated. The complement of this command is
21 B<fs getverify>, which shows the status of data verification in the client.
22
23 The default data verification status is disabled.
24
25 This is a global setting and applies to all subsequent connections to an
26 AFS File Server from this Cache Manager. There is no way to enable or
27 disable enverifyion for specific connections.
28
29 =head1 CAUTIONS
30
31 The B<fs setverify> command is only available on Microsoft Windows. There
32 is no equivalent for other platforms.
33
34 =head1 OPTIONS
35
36 =over 4
37
38 =item B<-verify> <I<on/off>>
39
40 This is the only option to B<fs setverify>. The B<-verify> option takes
41 either C<on> or C<off>. C<on> enables data verification. C<off> disables
42 data verification. Since this is the only option, the C<-verify> flag may be
43 omitted.
44
45 C<0> and C<1> or C<true> and C<false> are not supported as replacements
46 for C<on> and C<off>.
47
48 =item B<-help>
49
50 Prints the online help for this command. All other valid options are
51 ignored.
52
53 =back
54
55 =head1 OUTPUT
56
57 This command produces no output other than error messages.
58
59 =head1 EXAMPLES
60
61 There are only four ways to invoke B<fs setverify>. Either of:
62
63 % fs setverify -verify on
64 % fs setverify on
65
66 will enable data verification and:
67
68 % fs setverify -verify off
69 % fs setverify off
70
71 will disable data verification.
72
73 =head1 PRIVILEGE REQUIRED
74
75 The issuer must be logged in as the local superuser root.
76
77 =head1 SEE ALSO
78
79 L<fs_getverify(1)>
80
81 =head1 COPYRIGHT
82
83 Copyright 2012 Jeffrey Altman <jaltman@your-file-system.com>
84
85 This documentation is covered by the BSD License as written in the
86 doc/LICENSE file. This man page was written by Jeffrey Altman for
87 OpenAFS.