doc: the last partition name is /vicepiu
[openafs.git] / doc / man-pages / pod8 / bos_salvage.pod
index 4a98824..67c08fc 100644 (file)
@@ -1,26 +1,34 @@
 =head1 NAME
 
-bos salvage - Restores internal consistency to a file system or volume
+bos_salvage - Restores internal consistency to a file system or volume
 
 =head1 SYNOPSIS
 
-B<bos salvage> B<-server> <I<machine name>>
-    [B<-partition> <I<salvage partition>>]
-    [B<-volume> <I<salvage volume number or volume name>>]
-    [B<-file> <I<salvage log output file>>] [B<-all>] [B<-showlog>]
-    [B<-parallel> <I<# of max parallel partition salvaging>>]
-    [B<-tmpdir> <I<directory to place tmp files>>]
-    [B<-orphans> (ignore | remove | attach)] [B<-cell> <I<cell name>>]
+=for html
+<div class="synopsis">
+
+B<bos salvage> S<<< B<-server> <I<machine name>> >>>
+    S<<< [B<-partition> <I<salvage partition>>] >>>
+    S<<< [B<-volume> <I<salvage volume number or volume name>>] >>>
+    S<<< [B<-file> <I<salvage log output file>>] >>> [B<-all>] [B<-showlog>]
+    S<<< [B<-parallel> <I<# of max parallel partition salvaging>>] >>>
+    S<<< [B<-tmpdir> <I<directory to place tmp files>>] >>>
+    S<<< [B<-orphans> (ignore | remove | attach)] >>> S<<< [B<-cell> <I<cell name>>] >>>
+    S<<< [B<-forceDAFS>] >>>
     [B<-noauth>] [B<-localauth>] [B<-help>]
 
-B<bos sa> B<-se> <I<machine name>> [B<-part> <I<salvage partition>>]
-    [B<-v> <I<salvage volume number or volume name>>]
-    [B<-f> <I<salvage log output file>>] [B<-a>] [B<-sh>]
+B<bos sa> S<<< B<-se> <I<machine name>> >>> S<<< [B<-part> <I<salvage partition>>] >>>
+    S<<< [B<-v> <I<salvage volume number or volume name>>] >>>
+    S<<< [B<-f> <I<salvage log output file>>] >>> [B<-a>] [B<-sh>]
     [<-para> <I<# of max parallel partition salvaging>>]
-    [B<-t> <I<directory to place tmp files>>]
-    [B<-o> (ignore | remove | attach)] [B<-c> <I<cell name>>] [B<-n>]
+    S<<< [B<-t> <I<directory to place tmp files>>] >>>
+    S<<< [B<-o> (ignore | remove | attach)] >>> S<<< [B<-c> <I<cell name>>] >>> [B<-n>]
+    S<<< [B<-force>] >>>
     [B<-l>] [B<-h>]
 
+=for html
+</div>
+
 =head1 DESCRIPTION
 
 The B<bos salvage> command salvages (restores internal consistency to) one
@@ -131,8 +139,8 @@ partition, but do not count against the volume's quota.
 =head1 CAUTIONS
 
 Running this command can result in data loss if the Salvager process can
-repair corruption only by removing the offending data. Consult the I<IBM
-AFS Administration Guide> for more information.
+repair corruption only by removing the offending data. Consult the
+I<OpenAFS Administration Guide> for more information.
 
 =head1 OPTIONS
 
@@ -160,7 +168,7 @@ After F</vicepz> (for which the index is 25) comes
 
 and so on through
 
-   /vicepiv    =     vicepiv     =      iv     =      255
+   /vicepiu    =     vicepiu     =      iu     =      254
 
 =item B<-volume> <I<salvage volume id or name>>
 
@@ -272,6 +280,11 @@ directory.
 
 =back
 
+=item B<-forceDAFS>
+
+If the fileserver is a Demand Attach File Server, then the B<-forceDAFS>
+flag must be provided in order for the B<salvager> to run.
+
 =item B<-cell> <I<cell name>>
 
 Names the cell in which to run the command. Do not combine this argument
@@ -286,7 +299,8 @@ L<bos(8)>.
 =item B<-localauth>
 
 Constructs a server ticket using a key from the local
-F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
+F</usr/afs/etc/KeyFile> or F</usr/afs/etc/KeyFileExt> file.
+The B<bos> command interpreter presents the
 ticket to the BOS Server during mutual authentication. Do not combine this
 flag with the B<-cell> or B<-noauth> options. For more details, see
 L<bos(8)>.
@@ -301,20 +315,20 @@ ignored.
 =head1 EXAMPLES
 
 The following command salvages all volumes on the F</vicepd> partition of
-the machine C<db3.abc.com>:
+the machine C<db3.example.com>:
 
-   % bos salvage -server db3.abc.com -partition /vicepd
+   % bos salvage -server db3.example.com -partition /vicepd
 
 The following command salvages the volume with volume ID number 536870988
-on partition F</vicepb> of the machine C<fs2.abc.com>:
+on partition F</vicepb> of the machine C<fs2.example.com>:
 
-   % bos salvage -server fs2.abc.com -partition /vicepb -volume 536870988
+   % bos salvage -server fs2.example.com -partition /vicepb -volume 536870988
 
 The following command salvages all volumes on the machine
-C<fs4.abc.com>. Six Salvager processes run in parallel rather than the
+C<fs4.example.com>. Six Salvager processes run in parallel rather than the
 default four.
 
-   % bos salvage -server fs4.abc.com -all -parallel 6
+   % bos salvage -server fs4.example.com -all -parallel 6
 
 =head1 PRIVILEGE REQUIRED
 
@@ -326,16 +340,19 @@ included.
 =head1 SEE ALSO
 
 L<KeyFile(5)>,
+L<KeyFileExt(5)>,
 L<SalvageLog(5)>,
 L<UserList(5)>,
 L<bos(8)>,
 L<salvager(8)>,
+L<salvageserver(8)>,
 L<vos_backup(1)>,
 L<vos_release(1)>,
 L<vos_remove(1)>,
 L<vos_zap(1)>
 
-I<IBM AFS Administration Guide>
+The I<OpenAFS Administration Guide> at
+L<http://docs.openafs.org/AdminGuide/>.
 
 =head1 COPYRIGHT