Merge 1.8.0~pre4 packaging into master
[pkg-k5-afs_openafs.git] / doc / man-pages / pod8 / fssync-debug_vgcscanall.pod
blobdcbdc699eb2a0a12d87b7154c5098e929f54f0fe
1 =head1 NAME
3 fssync-debug_vgcscanall - Force a VG cache rescan on all partitions (FSYNC_VG_SCAN_ALL opcode)
5 =head1 SYNOPSIS
7 =for html
8 <div class="synopsis">
10 B<fssync-debug vgcscanall>
11     S<<< [B<-reason> <I<sync protocol reason code>>] >>>
12     S<<< [B<-programtype> <I<program type code>>] >>>
13     [B<-help>]
15 B<fssync-debug vgcscana>
16     S<<< [B<-r> <I<sync protocol reason code>>] >>>
17     S<<< [B<-pr> <I<program type code>>] >>>
18     [B<-h>]
20 =for html
21 </div>
23 =head1 DESCRIPTION
25 The B<fssync-debug vgcscanall> command forces a rescan of the volume
26 group cache (VGC) for all partitions attached by the fileserver.
28 =head1 OPTIONS
30 =over 4
32 =item B<-reason> <I<sync protocol reason code>>
34 Specifies numeric sync protocol reason code.
35 Available codes are listed in OpenAFS source file
36 F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
37 use B<-reason I<0>>.
39 =item B<-programtype> <I<program type code>>
41 Specifies program type code. Permitted values are
42 I<fileServer>,
43 I<volumeUtility>,
44 I<salvager>,
45 I<salvageServer>,
46 I<volumeServer> and
47 I<volumeSalvager>.
49 =item B<-help>
51 Prints the online help for this command. All other valid options are
52 ignored.
54 =back
56 =head1 PRIVILEGE REQUIRED
58 The issuer must have write access to the file server.
59 Usually, this means that the issuer must be the
60 local superuser C<root> on the file server machine.
62 =head1 SEE ALSO
64 L<fssync-debug_vgcadd(8)>,
65 L<fssync-debug_vgcdel(8)>,
66 L<fssync-debug_vgcquery(8)>,
67 L<fssync-debug_vgcscan(8)>,
69 =head1 COPYRIGHT
71 Copyright 2010 Sine Nomine Associates
73 This documentation is covered by the IBM Public License Version 1.0. This
74 man page was written by Andrew Deason and Davor Ocelic for OpenAFS.