README

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