e2fsck: map PROMPT_* values to prompt messages

[tools/e2fsprogs.git] / ext2ed / README

diff --git a/ext2ed/README b/ext2ed/README
index 2c64526..1f473cf 100644 (file)
--- a/ext2ed/README
+++ b/ext2ed/README
@@ -1,3 +1,45 @@
+ext2ed - The extended-2 filesystem editor, version e2fsprogs
+
+
+This version of ext2ed has been modified and updated by Theodore Ts'o
+for inclusion with the e2fsprogs package.  It now builds with modern
+ncurses and I've fixed various small bugs, particular in the redrawing
+and resizing functions.
+
+It is currently not built by default -- the top-level e2fsprogs
+Makefile doesn't recurse into this directory.  This is because ext2ed
+has a number of VERY SERIOUS shortcomings:
+
+1)  It doesn't work on filesystems bigger than 2GB
+
+2)  It assumes that all's the world an Intel, and assumes that
+       everything is in Intel (little-endian) byte order.
+
+Fixing either of these problems would be non-trivial, and so I at this
+point DO NOT RECOMMEND that distributions try to include this program,
+even as modified and updated in e2fsprogs.  This especially goes for
+Debian, where the Debian maintainer for e2fsprogs has a history of
+making authorized changes to e2fsprogs to include programs that aren't
+supported, and then starts bugging me with bug reports.  YES I KNOW.
+THIS PROGRAM HAS HORRIBLE SHORTCOMINGS.  IT IS INCLUDED HERE ONLY
+BECAUSE IT'S A CONVENIENT WAY FOR (FOR E2FSPROGS DEVELOPERS ON INTEL
+MACHINES) TO GENERATE TEST CASES BY SELECTIVELY CORRUPTING
+FILESYSTEMS.  I WILL NOT SUPPORT THIS PROGRAM FOR USE BY GENERAL USERS
+SO PLEASE DO NOT INCLUDE IT IN A DISTRIBUTION.
+
+I have currently disabled the use of GNU Readline in this program,
+because readline and ncurses really don't play well together at all.
+Readline assumes that it can write arbitrary text to the screen
+(especially when it tries to print out a completion list), which just
+doesn't work with ncurses.  Fixing this so they would work together
+would require wholesale changes to readline.   
+
+                               Theodore Ts'o
+                               tytso@MIT.EDU
+                               May 12, 2001
+
+----------------------------------------------------------------------------
+
 ext2ed - The extended-2 filesystem editor, version 0.2
 ------------------------------------------------------
 
@@ -6,10 +48,10 @@ This is version 0.2 of ext2ed - The extended-2 filesystem editor.
 Modifications on Apr 5 2001
 This is minor bug fixes to ext2ed, as of April 2001.
 It supports modern ext2 version that has file type in directory structure
-and fixes the missunderstanding between ncurses and
+and fixes the misunderstanding between ncurses and
 readline.
 
-I first applied patches from Redhat except the one for readline that 
+I first applied patches from Red Hat except the one for readline that 
 rewrote a readline behavior.
 
 Globals diffs between version 0.1 and 0.2 is stored in file :
@@ -72,7 +114,7 @@ that ncurses will be properly installed on your system:
        set your TERM environment variable to 'linux' or link
        l/linux to c/console in the terminfo database.
 
-4.     The percompiled binary was linked with ncurses 1.9.4 and will search
+4.     The precompiled binary was linked with ncurses 1.9.4 and will search
        for the terminfo database on /usr/local/lib/terminfo. If you are
        using it, and your 1.9.4 compatible terminfo database is not on the
        directory above, use the TERMINFO environment variable to specify