sbin/recoverdisk/recoverdisk.1

   1 .\" Copyright (c) 2006 Ulrich Spoerlein <uspoerlein@gmail.com>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd May 6, 2006
  28 .Dt RECOVERDISK 1
  29 .Os
  30 .Sh NAME
  31 .Nm recoverdisk
  32 .Nd recover data from hard disk or optical media
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl b Ar bigsize
  36 .Op Fl r Ar rlist
  37 .Op Fl s Ar snapshot
  38 .Op Fl w Ar wlist
  39 .Ar special
  40 .Op Ar file
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 utility reads data from the
  45 .Ar special
  46 file until all blocks could be successfully read.
  47 It starts reading in multiples of the sector size.
  48 Whenever a block fails, it is put to the end of the working queue and will be
  49 read again, possibly with a smaller read size.
  50 .Pp
  51 By default it uses block sizes of roughly 1 MB, 32kB, and the native
  52 sector size (usually 512 bytes).
  53 These figures are adjusted slightly, for devices whose sectorsize is not a
  54 power of 2, e.g., audio CDs with a sector size of 2352 bytes.
  55 .Pp
  56 .Pp
  57 The options are as follows:
  58 .Bl -tag -width indent
  59 .It Fl b Ar bigsize
  60 The size of reads attempted first.
  61 The middle pass is roughly the logarithmic average of the bigsize and
  62 the sectorsize.
  63 .It Fl r Ar rlist
  64 Read the list of blocks and block sizes to read from the specified file.
  65 .It Fl s Ar snapshot
  66 How often we should update the worklist file while things go OK.
  67 The default is 60 and the units is "progress messages" so if things
  68 go well, this is the same as once per minute.
  69 .It Fl w Ar wlist
  70 Write the list of remaining blocks to read to the specified file if
  71 .Nm
  72 is aborted via
  73 .Dv SIGINT .
  74 .El
  75 .Pp
  76 The
  77 .Fl r
  78 and
  79 .Fl w
  80 options can be specified together.
  81 Especially, they can point to the same file, which will be updated on abort.
  82 .Sh OUTPUT
  83 The
  84 .Nm
  85 utility
  86 prints several columns, detailing the progress
  87 .Bl -tag -width remaining
  88 .It Va start
  89 Starting offset of the current block.
  90 .It Va size
  91 Read size of the current block.
  92 .It Va len
  93 Length of the current block.
  94 .It Va state
  95 Is increased for every failed read.
  96 .It Va done
  97 Number of bytes already read.
  98 .It Va remaining
  99 Number of bytes remaining.
 100 .It Va "% done"
 101 Percent complete.
 102 .El
 103 .Sh EXAMPLES
 104 .Bd -literal
 105 # recover data from failing hard drive ad3
 106 touch /data/lots_of_space
 107 recoverdisk /dev/ad3 /data/lots_of_space
 108
 109 # clone a hard disk
 110 recoverdisk /dev/ad3 /dev/ad4
 111
 112 # read an ISO image from a CD-ROM
 113 touch /data/cd.iso; recoverdisk /dev/acd0 /data/cd.iso
 114
 115 # continue reading from a broken CD and update the existing worklist
 116 recoverdisk -r worklist -w worklist /dev/acd0 /data/cd.iso
 117
 118 # recover a single file from the unreadable media
 119 touch file.avi; recoverdisk /cdrom/file.avi file.avi
 120
 121 # If the disk hangs the system on read-errors try:
 122 recoverdisk -b 0 /dev/ad3 /somewhere
 123
 124 .Ed
 125 .Sh SEE ALSO
 126 .Xr dd 1
 127 .Sh HISTORY
 128 The
 129 .Nm
 130 utility first appeared in
 131 .Fx 7.0 .
 132 .Sh AUTHORS
 133 .An -nosplit
 134 The original implementation was done by
 135 .An Poul-Henning Kamp Aq phk@FreeBSD.org
 136 with minor improvements from
 137 .An Ulrich Sp\(:orlein Aq uspoerlein@gmail.com .
 138 .Pp
 139 This manual page was written by
 140 .An Ulrich Sp\(:orlein .
 141 .Sh BUGS
 142 Reading from media where the sectorsize is not a power of 2 will make all
 143 1 MB reads fail.
 144 This is due to the DMA reads being split up into blocks of at most 128kB.
 145 These reads then fail if the sectorsize is not a divisor of 128kB.
 146 When reading a full raw audio CD, this leads to roughly 700 error messages
 147 flying by.
 148 This is harmless.