README

   1
   2 mapsector -- Map sector number to file name(s)
   3
   4 Given a device and a sector number, mapsector will try to find the
   5 file name(s) mapping to this sector. It will try to gather as much
   6 information about the given sector as possible.
   7
   8 At the time of writing this README, mapsector has support for the
   9 following mapping schemes:
  10
  11     RAID level 1
  12     cryptsetup (luks and dmcrypt)
  13     LVM (linear allocation scheme)
  14     partition tables
  15
  16 and the following filesystems:
  17
  18     ext2-4
  19     reiserfs
  20
  21
  22 INSTALLATION
  23 ============
  24
  25 There are two ways to build mapsector:
  26
  27  - build a debian package
  28  - generate a combined 'mapsectorsh' script
  29
  30 The debian package will automatically install dependencies and
  31 'Suggests' all additional packages needed to detect all the known
  32 filesystems and mapping schemes.
  33
  34 The 'mapsectorsh' script is a single self-contained file which may be
  35 copied easily to any target system to be used. You need to make sure,
  36 that 'awk', 'python' and 'dc' are available.
  37
  38
  39 Getting the source
  40 ------------------
  41
  42 The sourcecode is distributed via git:
  43
  44  $ git clone git://git.j32.de/mapsector.git
  45
  46
  47 Building a debian package
  48 -------------------------
  49
  50 Make sure, you have 'fakeroot' and the debian package development
  51 tools installed, then issue
  52
  53  $ make deb
  54
  55 The resulting debian package will be placed into the parent directory.
  56
  57
  58 Building 'mapsectorsh'
  59 ----------------------
  60
  61 Just type
  62
  63  $ make
  64
  65 and copy the 'mapsectorsh' script wherever you need it.