ext2ed/README

   1 ext2ed - The extended-2 filesystem editor, version e2fsprogs
   2
   3
   4 This version of ext2ed has been modified and updated by Theodore Ts'o
   5 for inclusion with the e2fsprogs package.
   6
   7 It is currently not built by default -- the top-level e2fsprogs
   8 Makefile doesn't recurse into this directory.  This is because ext2ed
   9 has a number of VERY SERIOUS shortcomings:
  10
  11 1)  It doesn't work on filesystems bigger that 2GB
  12
  13 2)  It assumes that all's the world an Intel, and assumes that
  14         everything is in Intel (little-endian) byte order.
  15
  16 Fixing both of these problems are non-trivial, and so I at this point
  17 DO NOT RECOMMEND that distributions try to include this program, even
  18 as modified and updated in e2fsprogs.  This especially goes for
  19 Debian, where the Debian maintainer for e2fsprogs has a history of
  20 making authorized changes to e2fsprogs to include programs that aren't
  21 supported, and then starts bugging me with bug reports.  YES I KNOW.
  22 THIS PROGRAM HAS HORRIBLE SHORTCOMINGS.  IT IS INCLUDED HERE ONLY
  23 BECAUSE IT'S A CONVENIENT WAY FOR (FOR E2FSPROGS DEVELOPERS ON INTEL
  24 MACHINES) TO GENERATE TEST CASES BY SELECTIVELY CORRUPTING
  25 FILESYSTEMS.  I WILL NOT SUPPORT THIS PROGRAM FOR USE BY GENERAL
  26 USERS SO PLEASE DO NOT INCLUDE IT IN A DISTRIBUTION.
  27
  28 I have currently disabled the use of GNU Readline in this program,
  29 because readline and ncurses really don't play well together at all.
  30 Readline assumes that it can write arbitrary text to the screen
  31 (especially when it tries to print out a completion list), which just
  32 doesn't work with ncurses.  Fixing this so they would work together
  33 would require wholesale changes to readline.
  34
  35                                 Theodore Ts'o
  36                                 tytso@MIT.EDU
  37                                 May 12, 2001
  38
  39 ----------------------------------------------------------------------------
  40
  41 ext2ed - The extended-2 filesystem editor, version 0.2
  42 ------------------------------------------------------
  43
  44 This is version 0.2 of ext2ed - The extended-2 filesystem editor.
  45
  46 Modifications on Apr 5 2001
  47 This is minor bug fixes to ext2ed, as of April 2001.
  48 It supports modern ext2 version that has file type in directory structure
  49 and fixes the missunderstanding between ncurses and
  50 readline.
  51
  52 I first applied patches from Redhat except the one for readline that
  53 rewrote a readline behavior.
  54
  55 Globals diffs between version 0.1 and 0.2 is stored in file :
  56         diff-ext2ed.1.2
  57
  58 Christian Bac <Christian.Bac@nt-evry.fr>
  59
  60 ----------------------------------------------------------------------------
  61
  62 Documentation
  63 -------------
  64
  65 ext2ed's documentation consists of three documents:
  66
  67 1.      The user's guide.
  68 2.      Technical overview of the ext2 filesystem.
  69 3.      The EXT2ED design and implementation document.
  70
  71 Those documents are available in the doc directory, in linuxdoc-sgml and
  72 postscript formats.
  73
  74 The documentation is also available online at:
  75
  76 http://tochnapc2.technion.ac.il
  77
  78 under the ext2ed section.
  79
  80 Installation
  81 ------------
  82
  83 ext2ed requires the kernel sources and the readline and ncurses packages.
  84 Please edit the makefile if you are using an "old" version of ncurses (See the
  85 details below) or if gcc can't find the various header files and libraries.
  86
  87 To install, simply issue a 'make' command to compile and a 'make install'
  88 command to install. I have also included an already compiled linux a.out
  89 binary.
  90
  91 ext2ed and ncurses
  92 ------------------
  93
  94 ext2ed uses the ncurses library for terminal output. It is very important
  95 that ncurses will be properly installed on your system:
  96
  97 1.      Old versions of ncurses (around 1.8.5) need the OLD_NCURSES compile
  98         time option in EXT2ED.
  99
 100         At least from 1.9.2c, this flag should not be used. I would recommend
 101         upgrading the ncurses library to the newer versions.
 102
 103 2.      ncurses uses its own terminfo database rather then the termcap file.
 104         It is important that the terminfo database will be found by ncurses.
 105         If this is not the case, you will see on startup some lines which
 106         refer to /etc/termcap. This will mean that there is a problem with
 107         the terminfo database.
 108
 109 3.      Newer versions of ncurses (and the 1.3 series of the kernel) describe
 110         the linux console in the entry 'linux' and not 'console', as it was
 111         before. If you run ext2ed in the linux console, you should either
 112         set your TERM environment variable to 'linux' or link
 113         l/linux to c/console in the terminfo database.
 114
 115 4.      The percompiled binary was linked with ncurses 1.9.4 and will search
 116         for the terminfo database on /usr/local/lib/terminfo. If you are
 117         using it, and your 1.9.4 compatible terminfo database is not on the
 118         directory above, use the TERMINFO environment variable to specify
 119         an alternate location.
 120
 121 Running ext2ed
 122 --------------
 123
 124 For those of you who don't like reading lengthy articles, here are a few
 125 basic guidelines:
 126
 127 1.      Don't use ext2ed to change a mounted filesystem !
 128
 129         Using ext2ed in read-only mode on a mounted filesystem can be allowed
 130         by using the configuration file option 'AllowMountedRead on'. However,
 131         note that the displayed data will be unreliable.
 132
 133 2.      ext2ed currently can't handle filesystems bigger than 2 GB. I am
 134         sorry for the inconvenience. This will hopefully be fixed in future
 135         releases.
 136
 137 3.      Before running ext2ed, edit the configuration file
 138         /var/lib/ext2ed/ext2ed.conf to suit your needs. The various
 139         configuration options are documented there.
 140
 141 4.      Use the 'setdevice' command to open an ext2 filesystem.
 142         e.g. 'setdevice /dev/hda1'.
 143
 144 5.      If the filesystem is an ext2 filesystem and ext2ed fails to
 145         autodetect this, use the 'ForceExt2 on' configuration file option.
 146
 147 6.      The filesystem will always be opened in read-only mode. Feel free to
 148         experiment, but take care with the 'enablewrite' command.
 149
 150 -----------------------------------------------------------------------------
 151
 152 Feel free to send me feedback with anything regarding to ext2ed.
 153
 154 Enjoy,
 155
 156 Gadi Oxman <tgud@tochnapc2.technion.ac.il>
 157 Haifa, August 23 1995
 158