.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "FSSYNC-DEBUG 8"
.TH FSSYNC-DEBUG 8 2024-02-03 OpenAFS "AFS Command Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
fssync\-debug, dafssync\-debug \- Introduction to the fssync\-debug command suite
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBfssync-debug\fR command suite allows low-level inspection and control
of the file server volume packages.  The \fBdafssync-debug\fR command suite
is identical to \fBfssync-debug\fR, but is built with demand-attach support.
.PP
This command suite operates at an extremely low-level and hence requires
detailed knowledge of the OpenAFS architecture and code.  An understanding
of the OpenAFS volume finite-state machine is required before the state of
a volume should be manipulated.  Indiscriminate use of \fBfssync-debug\fR or
\&\fBdafssync-debug\fR in control mode can lead to extremely bad things
occurring. Use with care.
.SH OPTIONS
.IX Header "OPTIONS"
The following arguments and flags are available on many commands in the
\&\fBfssync-debug\fR suite. The reference page for each command also lists them,
but they may be described here in greater detail.
.IP "\fB\-volumeid\fR <\fIvolume ID\fR>" 4
.IX Item "-volumeid <volume ID>"
Specifies the numeric volume ID. Volume names are not permitted.
.IP "\fB\-partition\fR <\fIexact partition name\fR>" 4
.IX Item "-partition <exact partition name>"
Specifies the exact partition name (e.g. \fI/vicepa\fR). Abbreviations
are not permitted.
.IP "\fB\-reason\fR <\fIsync protocol reason code\fR>" 4
.IX Item "-reason <sync protocol reason code>"
Specifies numeric sync protocol reason code.
Available codes are listed in OpenAFS source file
\&\fIsrc/vol/fssync_inline.h\fR. For SYNC_REASON_NONE,
use \fB\-reason \fR\f(BI0\fR.
.IP "\fB\-programtype\fR <\fIprogram type code\fR>" 4
.IX Item "-programtype <program type code>"
Specifies program type code. Permitted values are
\&\fIfileServer\fR,
\&\fIvolumeUtility\fR,
\&\fIsalvager\fR,
\&\fIsalvageServer\fR,
\&\fIvolumeServer\fR and
\&\fIvolumeSalvager\fR.
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
The issuer must have write access to the file server.
Usually, this means that the issuer must be the
local superuser \f(CW\*(C`root\*(C'\fR on the file server machine.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBfssync\-debug_apropos\fR\|(8),
\&\fBfssync\-debug_attach\fR\|(8),
\&\fBfssync\-debug_callback\fR\|(8),
\&\fBfssync\-debug_detach\fR\|(8),
\&\fBfssync\-debug_error\fR\|(8),
\&\fBfssync\-debug_header\fR\|(8),
\&\fBfssync\-debug_help\fR\|(8),
\&\fBfssync\-debug_leaveoff\fR\|(8),
\&\fBfssync\-debug_list\fR\|(8),
\&\fBfssync\-debug_mode\fR\|(8),
\&\fBfssync\-debug_move\fR\|(8),
\&\fBfssync\-debug_offline\fR\|(8),
\&\fBfssync\-debug_online\fR\|(8),
\&\fBfssync\-debug_query\fR\|(8),
\&\fBfssync\-debug_stats\fR\|(8),
\&\fBfssync\-debug_vgcadd\fR\|(8),
\&\fBfssync\-debug_vgcdel\fR\|(8),
\&\fBfssync\-debug_vgcquery\fR\|(8),
\&\fBfssync\-debug_vgcscan\fR\|(8),
\&\fBfssync\-debug_vgcscanall\fR\|(8),
\&\fBfssync\-debug_vnode\fR\|(8),
\&\fBfssync\-debug_volop\fR\|(8)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2010 Davor Ocelic <docelic@spinlocksolutions.com>
.PP
This documentation is covered by the IBM Public License Version 1.0.  This
man page was written by Davor Ocelic for OpenAFS, based on documentation
from Steven Jenkins, Tom Keiser and Simon Wilkinson.