Provide manpage for fssync-debug and most subcmds
[openafs.git] / doc / man-pages / pod8 / fssync-debug_callback.pod
1 =head1 NAME
2
3 fssync-debug_callback - Breaks callbacks for a volume (FSYNC_VOL_BREAKCBKS opcode)
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<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
16 B<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
22 B<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
33 The 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
41 Specifies the numeric volume ID. Volume names are not permitted.
42
43 =item B<-partition> <I<exact partition name>>
44
45 Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
46 are not permitted.
47
48 =item B<-reason> <I<sync protocol reason code>>
49
50 Specifies numeric sync protocol reason code.
51 Available codes are listed in OpenAFS source file
52 F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
53 use B<-reason I<0>>.
54
55 =item B<-programtype> <I<program type code>>
56
57 Specifies program type code. Permitted values are
58 I<fileServer>,
59 I<volumeUtility>,
60 I<salvager>,
61 I<salvageServer>,
62 I<volumeServer> and
63 I<volumeSalvager>.
64
65 =back
66
67 =head1 PRIVILEGE REQUIRED
68
69 The issuer must have write access to the file server.
70 Usually, this means that the issuer must be the
71 local superuser C<root> on the file server machine.
72
73 =head1 SEE ALSO
74
75 L<fssync-debug_attach(8)>,
76 L<fssync-debug_detach(8)>,
77 L<fssync-debug_online(8)>,
78 L<fssync-debug_offline(8)>,
79 L<fssync-debug_leaveoff(8)>,
80 L<fssync-debug_error(8)>
81
82 =head1 COPYRIGHT
83
84 Copyright 2010 Davor Ocelic <docelic@spinlocksolutions.com>
85
86 This documentation is covered by the IBM Public License Version 1.0.  This
87 man page was written by Davor Ocelic for OpenAFS, based on documentation
88 from Steven Jenkins, Tom Keiser and Simon Wilkinson.