Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod8 / fssync-debug_callback.pod
CommitLineData
805e021f
CE
1=head1 NAME
2
3fssync-debug_callback - Breaks callbacks for a volume (FSYNC_VOL_BREAKCBKS opcode)
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<fssync-debug callback> S<<< B<-volumeid> <I<volume ID>> >>>
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
16B<fssync-debug ca> S<<< B<-v> <I<volume ID>> >>>
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
22B<fssync-debug cbk> S<<< B<-v> <I<volume ID>> >>>
23 S<<< [B<-pa> <I<exact partition name>>] >>>
24 S<<< [B<-r> <I<sync protocol reason code>>] >>>
25 S<<< [B<-pr> <I<program type code>>] >>>
26 [B<-h>]
27
28=for html
29</div>
30
31=head1 DESCRIPTION
32
33The B<fssync-debug callback> command breaks callbacks for a volume.
34
35=head1 OPTIONS
36
37=over 4
38
39=item B<-volumeid> <I<volume ID>>
40
41Specifies the numeric volume ID. Volume names are not permitted.
42
43=item B<-partition> <I<exact partition name>>
44
45Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
46are not permitted.
47
48=item B<-reason> <I<sync protocol reason code>>
49
50Specifies numeric sync protocol reason code.
51Available codes are listed in OpenAFS source file
52F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
53use B<-reason I<0>>.
54
55=item B<-programtype> <I<program type code>>
56
57Specifies program type code. Permitted values are
58I<fileServer>,
59I<volumeUtility>,
60I<salvager>,
61I<salvageServer>,
62I<volumeServer> and
63I<volumeSalvager>.
64
65=item B<-help>
66
67Prints the online help for this command. All other valid options are
68ignored.
69
70=back
71
72=head1 PRIVILEGE REQUIRED
73
74The issuer must have write access to the file server.
75Usually, this means that the issuer must be the
76local superuser C<root> on the file server machine.
77
78=head1 SEE ALSO
79
80L<fssync-debug_attach(8)>,
81L<fssync-debug_detach(8)>,
82L<fssync-debug_online(8)>,
83L<fssync-debug_offline(8)>,
84L<fssync-debug_leaveoff(8)>,
85L<fssync-debug_error(8)>
86
87=head1 COPYRIGHT
88
89Copyright 2010 Davor Ocelic <docelic@spinlocksolutions.com>
90
91This documentation is covered by the IBM Public License Version 1.0. This
92man page was written by Davor Ocelic for OpenAFS, based on documentation
93from Steven Jenkins, Tom Keiser and Simon Wilkinson.