jimzah/openafs
1
0
Fork 0
mirror of https://git.openafs.org/openafs.git synced 2025-01-19 07:20:11 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
4f7d192bcb
openafs/doc/man-pages/pod8/fssync-debug.pod

92 lines
2.6 KiB
Plaintext
Raw Normal View History

Provide manpage for fssync-debug and most subcmds 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>
2010-06-20 14:38:14 +01:00
=head1 NAME
Link dafssync-debug(8) to fssync-debug(8) The two commands are documented identically for right now, so just link the dafssync-debug man page to the fssync-debug man page. Remove the incorrect statement in the man page that fssync-debug only works with demand-attach. FIXES 128166 Change-Id: I812641ad7a345c7f5412c3c97ed1ba393e981639 Reviewed-on: http://gerrit.openafs.org/2836 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@dementia.org> Tested-by: Derrick Brashear <shadow@dementia.org>
2010-09-23 00:34:42 +01:00
fssync-debug, dafssync-debug - Introduction to the fssync-debug command suite
Provide manpage for fssync-debug and most subcmds 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>
2010-06-20 14:38:14 +01:00
=head1 DESCRIPTION
Link dafssync-debug(8) to fssync-debug(8) The two commands are documented identically for right now, so just link the dafssync-debug man page to the fssync-debug man page. Remove the incorrect statement in the man page that fssync-debug only works with demand-attach. FIXES 128166 Change-Id: I812641ad7a345c7f5412c3c97ed1ba393e981639 Reviewed-on: http://gerrit.openafs.org/2836 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@dementia.org> Tested-by: Derrick Brashear <shadow@dementia.org>
2010-09-23 00:34:42 +01:00
The B<fssync-debug> command suite allows low-level inspection and control
of the file server volume packages. The B<dafssync-debug> command suite
is identical to B<fssync-debug>, but is built with demand-attach support.
Provide manpage for fssync-debug and most subcmds 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>
2010-06-20 14:38:14 +01:00
Link dafssync-debug(8) to fssync-debug(8) The two commands are documented identically for right now, so just link the dafssync-debug man page to the fssync-debug man page. Remove the incorrect statement in the man page that fssync-debug only works with demand-attach. FIXES 128166 Change-Id: I812641ad7a345c7f5412c3c97ed1ba393e981639 Reviewed-on: http://gerrit.openafs.org/2836 Tested-by: BuildBot <buildbot@rampaginggeek.com> Reviewed-by: Derrick Brashear <shadow@dementia.org> Tested-by: Derrick Brashear <shadow@dementia.org>
2010-09-23 00:34:42 +01:00
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 B<fssync-debug> or
B<dafssync-debug> in control mode can lead to extremely bad things
occurring. Use with care.
Provide manpage for fssync-debug and most subcmds 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>
2010-06-20 14:38:14 +01:00
=head1 OPTIONS
The following arguments and flags are available on many commands in the
B<fssync-debug> suite. The reference page for each command also lists them,
but they may be described here in greater detail.
=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_apropos(8)>,
L<fssync-debug_attach(8)>,
L<fssync-debug_callback(8)>,
L<fssync-debug_detach(8)>,
L<fssync-debug_error(8)>,
L<fssync-debug_header(8)>,
L<fssync-debug_help(8)>,
L<fssync-debug_leaveoff(8)>,
L<fssync-debug_list(8)>,
L<fssync-debug_mode(8)>,
L<fssync-debug_move(8)>,
L<fssync-debug_offline(8)>,
L<fssync-debug_online(8)>,
L<fssync-debug_query(8)>,
L<fssync-debug_stats(8)>,
L<fssync-debug_vgcadd(8)>,
L<fssync-debug_vgcdel(8)>,
L<fssync-debug_vgcquery(8)>,
L<fssync-debug_vgcscan(8)>,
L<fssync-debug_vgcscanall(8)>,
L<fssync-debug_vnode(8)>,
L<fssync-debug_volop(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.
Reference in New Issue Copy Permalink