ext2ed/README

   1 ext2ed - The extended-2 filesystem editor, version 0.2
   2 ------------------------------------------------------
   3
   4 This is version 0.2 of ext2ed - The extended-2 filesystem editor.
   5
   6 Modifications on Apr 5 2001
   7 This is minor bug fixes to ext2ed, as of April 2001.
   8 It supports modern ext2 version that has file type in directory structure
   9 and fixes the missunderstanding between ncurses and
  10 readline.
  11
  12 I first applied patches from Redhat except the one for readline that
  13 rewrote a readline behavior.
  14
  15 Globals diffs between version 0.1 and 0.2 is stored in file :
  16         diff-ext2ed.1.2
  17
  18 Christian Bac <Christian.Bac@nt-evry.fr>
  19
  20 ----------------------------------------------------------------------------
  21
  22 Documentation
  23 -------------
  24
  25 ext2ed's documentation consists of three documents:
  26
  27 1.      The user's guide.
  28 2.      Technical overview of the ext2 filesystem.
  29 3.      The EXT2ED design and implementation document.
  30
  31 Those documents are available in the doc directory, in linuxdoc-sgml and
  32 postscript formats.
  33
  34 The documentation is also available online at:
  35
  36 http://tochnapc2.technion.ac.il
  37
  38 under the ext2ed section.
  39
  40 Installation
  41 ------------
  42
  43 ext2ed requires the kernel sources and the readline and ncurses packages.
  44 Please edit the makefile if you are using an "old" version of ncurses (See the
  45 details below) or if gcc can't find the various header files and libraries.
  46
  47 To install, simply issue a 'make' command to compile and a 'make install'
  48 command to install. I have also included an already compiled linux a.out
  49 binary.
  50
  51 ext2ed and ncurses
  52 ------------------
  53
  54 ext2ed uses the ncurses library for terminal output. It is very important
  55 that ncurses will be properly installed on your system:
  56
  57 1.      Old versions of ncurses (around 1.8.5) need the OLD_NCURSES compile
  58         time option in EXT2ED.
  59
  60         At least from 1.9.2c, this flag should not be used. I would recommend
  61         upgrading the ncurses library to the newer versions.
  62
  63 2.      ncurses uses its own terminfo database rather then the termcap file.
  64         It is important that the terminfo database will be found by ncurses.
  65         If this is not the case, you will see on startup some lines which
  66         refer to /etc/termcap. This will mean that there is a problem with
  67         the terminfo database.
  68
  69 3.      Newer versions of ncurses (and the 1.3 series of the kernel) describe
  70         the linux console in the entry 'linux' and not 'console', as it was
  71         before. If you run ext2ed in the linux console, you should either
  72         set your TERM environment variable to 'linux' or link
  73         l/linux to c/console in the terminfo database.
  74
  75 4.      The percompiled binary was linked with ncurses 1.9.4 and will search
  76         for the terminfo database on /usr/local/lib/terminfo. If you are
  77         using it, and your 1.9.4 compatible terminfo database is not on the
  78         directory above, use the TERMINFO environment variable to specify
  79         an alternate location.
  80
  81 Running ext2ed
  82 --------------
  83
  84 For those of you who don't like reading lengthy articles, here are a few
  85 basic guidelines:
  86
  87 1.      Don't use ext2ed to change a mounted filesystem !
  88
  89         Using ext2ed in read-only mode on a mounted filesystem can be allowed
  90         by using the configuration file option 'AllowMountedRead on'. However,
  91         note that the displayed data will be unreliable.
  92
  93 2.      ext2ed currently can't handle filesystems bigger than 2 GB. I am
  94         sorry for the inconvenience. This will hopefully be fixed in future
  95         releases.
  96
  97 3.      Before running ext2ed, edit the configuration file
  98         /var/lib/ext2ed/ext2ed.conf to suit your needs. The various
  99         configuration options are documented there.
 100
 101 4.      Use the 'setdevice' command to open an ext2 filesystem.
 102         e.g. 'setdevice /dev/hda1'.
 103
 104 5.      If the filesystem is an ext2 filesystem and ext2ed fails to
 105         autodetect this, use the 'ForceExt2 on' configuration file option.
 106
 107 6.      The filesystem will always be opened in read-only mode. Feel free to
 108         experiment, but take care with the 'enablewrite' command.
 109
 110 -----------------------------------------------------------------------------
 111
 112 Feel free to send me feedback with anything regarding to ext2ed.
 113
 114 Enjoy,
 115
 116 Gadi Oxman <tgud@tochnapc2.technion.ac.il>
 117 Haifa, August 23 1995
 118