openafs/doc/man-pages/pod8/fssync-debug_vnode.pod
Andrew Deason 5cc6293c2c Provide man pages for more fssync-debug commands
Provide man pages for the fssync-debug commands vgcadd, vgcdel,
vgcquery, vgcscan, vgcscanall, vnode, and volop.

Change-Id: If456a4cdfedbf5f2776c276bc20178319638c26a
Reviewed-on: http://gerrit.openafs.org/2239
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Tested-by: Derrick Brashear <shadow@dementia.org>
2010-07-12 11:53:41 -07:00

90 lines
2.1 KiB
Plaintext

=head1 NAME
fssync-debug_vnode - Display vnode info (FSYNC_VOL_QUERY_VNODE opcode)
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<fssync-debug vnode> S<<< B<-volumeid> <I<volume ID>> >>>
S<<< B<-vnodeid> <I<vnode ID>> >>>
S<<< B<-unique> <I<uniquifier>> >>>
S<<< B<-partition> <I<exact partition name>> >>>
S<<< [B<-reason> <I<sync protocol reason code>>] >>>
S<<< [B<-programtype> <I<program type code>>] >>>
[B<-help>]
B<fssync-debug vn> S<<< B<-vo> <I<volume ID>> >>>
S<<< B<-vn> <I<vnode ID>> >>>
S<<< B<-u> <I<uniquifier>> >>>
S<<< B<-pa> <I<exact partition name>> >>>
S<<< [B<-r> <I<sync protocol reason code>>] >>>
S<<< [B<-pr> <I<program type code>>] >>>
=for html
</div>
=head1 DESCRIPTION
The B<fssync-debug vnode> command displays information about a given
vnode.
=head1 OPTIONS
=over 4
=item B<-volumeid> <I<volume ID>>
Specifies the numeric volume ID. Volume names are not permitted.
=item B<-vnodeid> <I<vnode ID>>
Specifies the numeric vnode ID.
=item B<-unique> <I<uniquifier>>
Specifies the numeric vnode uniquifier.
=item B<-partition> <I<exact partition name>>
Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
are not permitted.
=item B<-reason> <I<sync protocol reason code>>
Specifies numeric sync protocol reason code.
Available codes are listed in OpenAFS source file
F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
use B<-reason I<0>>.
=item B<-programtype> <I<program type code>>
Specifies program type code. Permitted values are
I<fileServer>,
I<volumeUtility>,
I<salvager>,
I<salvageServer>,
I<volumeServer> and
I<volumeSalvager>.
=back
=head1 PRIVILEGE REQUIRED
The issuer must have write access to the file server.
Usually, this means that the issuer must be the
local superuser C<root> on the file server machine.
=head1 SEE ALSO
L<fssync-debug_header(8)>,
L<fssync-debug_query(8)>,
=head1 COPYRIGHT
Copyright 2010 Sine Nomine Associates
This documentation is covered by the IBM Public License Version 1.0. This
man page was written by Andrew Deason and Davor Ocelic for OpenAFS.