Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod8 / fssync-debug_attach.pod
CommitLineData
805e021f
CE
1=head1 NAME
2
3fssync-debug_attach - Forces full volume attachment (FSYNC_VOL_ATTACH opcode)
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<fssync-debug attach> S<<< B<-volumeid> <I<volume ID>> >>>
11 S<<< [B<-partition> <I<exact partition name>>] >>>
12 S<<< [B<-reason> <I<sync protocol reason code>>] >>>
13 S<<< [B<-programtype> <I<program type code>>] >>>
14 [B<-help>]
15
16B<fssync-debug at> S<<< B<-v> <I<volume ID>> >>>
17 S<<< [B<-pa> <I<exact partition name>>] >>>
18 S<<< [B<-r> <I<sync protocol reason code>>] >>>
19 S<<< [B<-pr> <I<program type code>>] >>>
20 [B<-h>]
21
22=for html
23</div>
24
25=head1 DESCRIPTION
26
27The B<fssync-debug attach> command forces full attachment of
28a volume.
29
30=head1 OPTIONS
31
32=over 4
33
34=item B<-volumeid> <I<volume ID>>
35
36Specifies the numeric volume ID. Volume names are not permitted.
37
38=item B<-partition> <I<exact partition name>>
39
40Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
41are not permitted.
42
43=item B<-reason> <I<sync protocol reason code>>
44
45Specifies numeric sync protocol reason code.
46Available codes are listed in OpenAFS source file
47F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
48use B<-reason I<0>>.
49
50=item B<-programtype> <I<program type code>>
51
52Specifies program type code. Permitted values are
53I<fileServer>,
54I<volumeUtility>,
55I<salvager>,
56I<salvageServer>,
57I<volumeServer> and
58I<volumeSalvager>.
59
60=item B<-help>
61
62Prints the online help for this command. All other valid options are
63ignored.
64
65=back
66
67=head1 PRIVILEGE REQUIRED
68
69The issuer must have write access to the file server.
70Usually, this means that the issuer must be the
71local superuser C<root> on the file server machine.
72
73=head1 SEE ALSO
74
75L<fssync-debug_detach(8)>,
76L<fssync-debug_callback(8)>,
77L<fssync-debug_online(8)>,
78L<fssync-debug_offline(8)>,
79L<fssync-debug_error(8)>
80
81=head1 COPYRIGHT
82
83Copyright 2010 Davor Ocelic <docelic@spinlocksolutions.com>
84
85This documentation is covered by the IBM Public License Version 1.0. This
86man page was written by Davor Ocelic for OpenAFS, based on documentation
87from Steven Jenkins, Tom Keiser and Simon Wilkinson.