Provide man pages for more fssync-debug commands
[openafs.git] / doc / man-pages / pod8 / fssync-debug_vgcscan.pod
1 =head1 NAME
2
3 fssync-debug_vgcscan - Force a VG cache rescan (FSYNC_VG_SCAN opcode)
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fssync-debug vgcscan>
11     S<<< B<-partition> <I<exact partition name>> >>>
12     S<<< [B<-reason> <I<sync protocol reason code>>] >>>
13     S<<< [B<-programtype> <I<program type code>>] >>>
14     [B<-help>]
15
16 B<fssync-debug vgcscan>
17     S<<< B<-pa> <I<exact partition name>> >>>
18     S<<< [B<-r> <I<sync protocol reason code>>] >>>
19     S<<< [B<-pr> <I<program type code>>] >>>
20     [B<-h>]
21
22 =for html
23 </div>
24
25 =head1 DESCRIPTION
26
27 The B<fssync-debug vgcscan> command forces a rescan of the volume group
28 cache (VGC) for a particular partition.
29
30 =head1 OPTIONS
31
32 =over 4
33
34 =item B<-partition> <I<exact partition name>>
35
36 Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
37 are not permitted.
38
39 =item B<-reason> <I<sync protocol reason code>>
40
41 Specifies numeric sync protocol reason code.
42 Available codes are listed in OpenAFS source file
43 F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
44 use B<-reason I<0>>.
45
46 =item B<-programtype> <I<program type code>>
47
48 Specifies program type code. Permitted values are
49 I<fileServer>,
50 I<volumeUtility>,
51 I<salvager>,
52 I<salvageServer>,
53 I<volumeServer> and
54 I<volumeSalvager>.
55
56 =back
57
58 =head1 PRIVILEGE REQUIRED
59
60 The issuer must have write access to the file server.
61 Usually, this means that the issuer must be the
62 local superuser C<root> on the file server machine.
63
64 =head1 SEE ALSO
65
66 L<fssync-debug_vgcadd(8)>,
67 L<fssync-debug_vgcdel(8)>,
68 L<fssync-debug_vgcquery(8)>,
69 L<fssync-debug_vgcscanall(8)>,
70
71 =head1 COPYRIGHT
72
73 Copyright 2010 Sine Nomine Associates
74
75 This documentation is covered by the IBM Public License Version 1.0. This
76 man page was written by Andrew Deason and Davor Ocelic for OpenAFS.