Linux: Fix AFS_NORETURN violation with osi_AssertFailK
[openafs.git] / doc / man-pages / pod8 / fssync-debug_attach.pod
1 =head1 NAME
2
3 fssync-debug_attach - Forces full volume attachment (FSYNC_VOL_ATTACH opcode)
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<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
16 B<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
27 The B<fssync-debug attach> command forces full attachment of
28 a volume.
29
30 =head1 OPTIONS
31
32 =over 4
33
34 =item B<-volumeid> <I<volume ID>>
35
36 Specifies the numeric volume ID. Volume names are not permitted.
37
38 =item B<-partition> <I<exact partition name>>
39
40 Specifies the exact partition name (e.g. I</vicepa>). Abbreviations
41 are not permitted.
42
43 =item B<-reason> <I<sync protocol reason code>>
44
45 Specifies numeric sync protocol reason code.
46 Available codes are listed in OpenAFS source file
47 F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE,
48 use B<-reason I<0>>.
49
50 =item B<-programtype> <I<program type code>>
51
52 Specifies program type code. Permitted values are
53 I<fileServer>,
54 I<volumeUtility>,
55 I<salvager>,
56 I<salvageServer>,
57 I<volumeServer> and
58 I<volumeSalvager>.
59
60 =back
61
62 =head1 PRIVILEGE REQUIRED
63
64 The issuer must have write access to the file server.
65 Usually, this means that the issuer must be the
66 local superuser C<root> on the file server machine.
67
68 =head1 SEE ALSO
69
70 L<fssync-debug_detach(8)>,
71 L<fssync-debug_callback(8)>,
72 L<fssync-debug_online(8)>,
73 L<fssync-debug_offline(8)>,
74 L<fssync-debug_error(8)>
75
76 =head1 COPYRIGHT
77
78 Copyright 2010 Davor Ocelic <docelic@spinlocksolutions.com>
79
80 This documentation is covered by the IBM Public License Version 1.0.  This
81 man page was written by Davor Ocelic for OpenAFS, based on documentation
82 from Steven Jenkins, Tom Keiser and Simon Wilkinson.