Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod8 / fssync-debug_vgcdel.pod
CommitLineData
805e021f
CE
1=head1 NAME
2
3fssync-debug_vgcdel - Delete an entry from the VG cache (FSYNC_VG_UPDATE opcode)
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<fssync-debug vgcdel>
11 S<<< B<-partition> <I<exact partition name>> >>>
12 S<<< B<-parent> <I<volume ID>> >>>
13 S<<< B<-child> <I<volume ID>> >>>
14 S<<< [B<-reason> <I<sync protocol reason code>>] >>>
15 S<<< [B<-programtype> <I<program type code>>] >>>
16 [B<-help>]
17
18B<fssync-debug vgcd>
19 S<<< B<-part> <I<exact partition name>> >>>
20 S<<< B<-pare> <I<volume ID>> >>>
21 S<<< B<-c> <I<volume ID>> >>>
22 S<<< [B<-r> <I<sync protocol reason code>>] >>>
23 S<<< [B<-pr> <I<program type code>>] >>>
24 [B<-h>]
25
26=for html
27</div>
28
29=head1 DESCRIPTION
30
31The B<fssync-debug vgcdel> command deletes an entry from the volume
32group cache (VGC).
33
34=head1 OPTIONS
35
36=over 4
37
38=item B<-partition> <I<exact partition name>>
39
40Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
41are not permitted.
42
43=item B<-parent> <I<volume ID>>
44
45Specifies the numeric volume ID for the parent volume of the VGC entry.
46
47=item B<-child> <I<volume ID>>
48
49Specifies the numeric volume ID for the child volume in the VGC entry
50to delete.
51
52=item B<-reason> <I<sync protocol reason code>>
53
54Specifies numeric sync protocol reason code.
55Available codes are listed in OpenAFS source file
56F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
57use B<-reason I<0>>.
58
59=item B<-programtype> <I<program type code>>
60
61Specifies program type code. Permitted values are
62I<fileServer>,
63I<volumeUtility>,
64I<salvager>,
65I<salvageServer>,
66I<volumeServer> and
67I<volumeSalvager>.
68
69=item B<-help>
70
71Prints the online help for this command. All other valid options are
72ignored.
73
74=back
75
76=head1 PRIVILEGE REQUIRED
77
78The issuer must have write access to the file server.
79Usually, this means that the issuer must be the
80local superuser C<root> on the file server machine.
81
82=head1 SEE ALSO
83
84L<fssync-debug_vgcadd(8)>,
85L<fssync-debug_vgcquery(8)>,
86L<fssync-debug_vgcscan(8)>,
87L<fssync-debug_vgcscanall(8)>,
88
89=head1 COPYRIGHT
90
91Copyright 2010 Sine Nomine Associates
92
93This documentation is covered by the IBM Public License Version 1.0. This
94man page was written by Andrew Deason and Davor Ocelic for OpenAFS.