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