HCoop / hcoop / debian / openafs.git / blame
| Commit | Line | Data |
|---|---|---|
| 805e021f CE |
1 | =head1 NAME |
| 2 | ||
| 3 | fssync-debug_list - Historical sync command (FSYNC_VOL_LISTVOLUMES opcode) | |
| 4 | ||
| 5 | =head1 SYNOPSIS | |
| 6 | ||
| 7 | =for html | |
| 8 | <div class="synopsis"> | |
| 9 | ||
| 10 | B<fssync-debug list> 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 li> 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 | B<fssync-debug ls> S<<< B<-v> <I<volume ID>> >>> | |
| 23 | S<<< [B<-pa> <I<exact partition name>>] >>> | |
| 24 | S<<< [B<-r> <I<sync protocol reason code>>] >>> | |
| 25 | S<<< [B<-pr> <I<program type code>>] >>> | |
| 26 | [B<-h>] | |
| 27 | ||
| 28 | =for html | |
| 29 | </div> | |
| 30 | ||
| 31 | =head1 DESCRIPTION | |
| 32 | ||
| 33 | The B<fssync-debug list> does nothing but return success, assuming | |
| 34 | the fileserver is available. The opcode it calls exists for | |
| 35 | historical reasons, and now does nothing. | |
| 36 | ||
| 37 | =head1 OPTIONS | |
| 38 | ||
| 39 | =over 4 | |
| 40 | ||
| 41 | =item B<-volumeid> <I<volume ID>> | |
| 42 | ||
| 43 | Specifies the numeric volume ID. Volume names are not permitted. | |
| 44 | ||
| 45 | =item B<-partition> <I<exact partition name>> | |
| 46 | ||
| 47 | Specifies the exact partition name (e.g. I</vicepa>). Abbreviations | |
| 48 | are not permitted. | |
| 49 | ||
| 50 | =item B<-reason> <I<sync protocol reason code>> | |
| 51 | ||
| 52 | Specifies numeric sync protocol reason code. | |
| 53 | Available codes are listed in OpenAFS source file | |
| 54 | F<src/vol/fssync_inline.h>. For SYNC_REASON_NONE, | |
| 55 | use B<-reason I<0>>. | |
| 56 | ||
| 57 | =item B<-programtype> <I<program type code>> | |
| 58 | ||
| 59 | Specifies program type code. Permitted values are | |
| 60 | I<fileServer>, | |
| 61 | I<volumeUtility>, | |
| 62 | I<salvager>, | |
| 63 | I<salvageServer>, | |
| 64 | I<volumeServer> and | |
| 65 | I<volumeSalvager>. | |
| 66 | ||
| 67 | =item B<-help> | |
| 68 | ||
| 69 | Prints the online help for this command. All other valid options are | |
| 70 | ignored. | |
| 71 | ||
| 72 | =back | |
| 73 | ||
| 74 | =head1 PRIVILEGE REQUIRED | |
| 75 | ||
| 76 | The issuer must have write access to the file server. | |
| 77 | Usually, this means that the issuer must be the | |
| 78 | local superuser C<root> on the file server machine. | |
| 79 | ||
| 80 | =head1 SEE ALSO | |
| 81 | ||
| 82 | L<fssync-debug_header(8)>, | |
| 83 | L<fssync-debug_stats(8)> | |
| 84 | ||
| 85 | =head1 COPYRIGHT | |
| 86 | ||
| 87 | Copyright 2010 Davor Ocelic <docelic@spinlocksolutions.com> | |
| 88 | ||
| 89 | This documentation is covered by the IBM Public License Version 1.0. This | |
| 90 | man page was written by Davor Ocelic for OpenAFS, based on documentation | |
| 91 | from Steven Jenkins, Tom Keiser and Simon Wilkinson. |