mirror of
https://git.openafs.org/openafs.git
synced 2025-01-19 07:20:11 +00:00
8c633162b9
This is another patch in the series to provide manpages for dafs-related commands. Most (if not all) documentation is coming from source documentation and DAFS articles/presentations. The primary motivation behind this is to comply with Debian guidelines requiring all binaries to have respective manpages. This patch has been sitting here for months, so it's good time to finally submit it. Note that fssync-debug also supports some vcg* commands, for which I was not able to find any documentation I could use. So, they are still left to be documented. Change-Id: I9d067766e2a90b26646edc87f15a4f533c5c8d44 Reviewed-on: http://gerrit.openafs.org/2220 Reviewed-by: Russ Allbery <rra@stanford.edu> Tested-by: Russ Allbery <rra@stanford.edu>
83 lines
2.0 KiB
Plaintext
83 lines
2.0 KiB
Plaintext
=head1 NAME
|
|
|
|
fssync-debug_offline - Brings a volume offline (FSYNC_VOL_OFF opcode)
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
=for html
|
|
<div class="synopsis">
|
|
|
|
B<fssync-debug offline> S<<< B<-volumeid> <I<volume ID>> >>>
|
|
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 of> S<<< B<-v> <I<volume ID>> >>>
|
|
S<<< [B<-pa> <I<exact partition name>>] >>>
|
|
S<<< [B<-r> <I<sync protocol reason code>>] >>>
|
|
S<<< [B<-pr> <I<program type code>>] >>>
|
|
[B<-h>]
|
|
|
|
=for html
|
|
</div>
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The B<fssync-debug offline> command brings a volume offline.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item B<-volumeid> <I<volume ID>>
|
|
|
|
Specifies the numeric volume ID. Volume names are not permitted.
|
|
|
|
=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_attach(8)>,
|
|
L<fssync-debug_detach(8)>,
|
|
L<fssync-debug_callback(8)>,
|
|
L<fssync-debug_online(8)>,
|
|
L<fssync-debug_leaveoff(8)>,
|
|
L<fssync-debug_error(8)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2010 Davor Ocelic <docelic@spinlocksolutions.com>
|
|
|
|
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.
|