Linux: Fix AFS_NORETURN violation with osi_AssertFailK
[openafs.git] / doc / man-pages / pod8 / fssync-debug_vnode.pod
1 =head1 NAME
2
3 fssync-debug_vnode - Display vnode info (FSYNC_VOL_QUERY_VNODE opcode)
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fssync-debug vnode> S<<< B<-volumeid> <I<volume ID>> >>>
11     S<<< B<-vnodeid> <I<vnode ID>> >>>
12     S<<< B<-unique> <I<uniquifier>> >>>
13     S<<< B<-partition> <I<exact partition name>> >>>
14     S<<< [B<-reason> <I<sync protocol reason code>>] >>>
15     S<<< [B<-programtype> <I<program type code>>] >>>
16     [B<-help>]
17
18 B<fssync-debug vn> S<<< B<-vo> <I<volume ID>> >>>
19     S<<< B<-vn> <I<vnode ID>> >>>
20     S<<< B<-u> <I<uniquifier>> >>>
21     S<<< B<-pa> <I<exact partition name>> >>>
22     S<<< [B<-r> <I<sync protocol reason code>>] >>>
23     S<<< [B<-pr> <I<program type code>>] >>>
24
25 =for html
26 </div>
27
28 =head1 DESCRIPTION
29
30 The B<fssync-debug vnode> command displays information about a given
31 vnode.
32
33 =head1 OPTIONS
34
35 =over 4
36
37 =item B<-volumeid> <I<volume ID>>
38
39 Specifies the numeric volume ID. Volume names are not permitted.
40
41 =item B<-vnodeid> <I<vnode ID>>
42
43 Specifies the numeric vnode ID.
44
45 =item B<-unique> <I<uniquifier>>
46
47 Specifies the numeric vnode uniquifier.
48
49 =item B<-partition> <I<exact partition name>>
50
51 Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
52 are not permitted.
53
54 =item B<-reason> <I<sync protocol reason code>>
55
56 Specifies numeric sync protocol reason code.
57 Available codes are listed in OpenAFS source file
58 F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
59 use B<-reason I<0>>.
60
61 =item B<-programtype> <I<program type code>>
62
63 Specifies program type code. Permitted values are
64 I<fileServer>,
65 I<volumeUtility>,
66 I<salvager>,
67 I<salvageServer>,
68 I<volumeServer> and
69 I<volumeSalvager>.
70
71 =back
72
73 =head1 PRIVILEGE REQUIRED
74
75 The issuer must have write access to the file server.
76 Usually, this means that the issuer must be the
77 local superuser C<root> on the file server machine.
78
79 =head1 SEE ALSO
80
81 L<fssync-debug_header(8)>,
82 L<fssync-debug_query(8)>,
83
84 =head1 COPYRIGHT
85
86 Copyright 2010 Sine Nomine Associates
87
88 This documentation is covered by the IBM Public License Version 1.0.  This
89 man page was written by Andrew Deason and Davor Ocelic for OpenAFS.