Fri Jan 21 18:40:13 PST 2000 Michael Jennings <mej@eterm.org>

	Apparently someone was confused by the out-of-date README file, so I
	updated it.


SVN revision: 1959

1 files changed, 58 insertions, 101 deletions

diff --git a/README b/README
index 6885156..950fafd 100644
--- a/README
+++ b/README
@@ -1,124 +1,81 @@
-Release notes for Eterm Development Release 0.8
------------------------------------------------
+Release notes for Eterm 0.9
+---------------------------
 
 Software Requirements
 ---------------------
-- The usual X11R6 stuff
-- Rasterman's Imlib and the libraries it needs. Visit
-  http://www.labs.redhat.com/imlib/ for more information.
-- Even though Eterm works with any window manager, you just might get extra
-  fancies by using the Enlightenment window manager from Rasterman and
-  Mandrake - http://www.enlightenment.org/ for more information. Now go see
-  what your desktop can look like with E. :) -vendu
-
-Documentation to read
----------------------
-- The FAQ at http://www.eterm.org/
-- Run "Eterm -h" - you'll see the command line options.
-
-ATTENTION!  Active Tags Warning!
---------------------------------
-
-NOTE: It looks like the latest resize-crashes happen in the active tags
-code. We'll try to get this fixed as soon as possible. Until then, if you
-want to use tags, you may want to see the FIXME notes in screen.c for what
-NULL pointer checks to remove.
-
-Preliminary support for active tags by Nat Friedman has been added.
-Thanks, Nat :) (http://dingus.mit.edu/ for more info)
-
-This will definitely need more work :) Sorry if it's buggy (I'd expect it
-to be >:). -vendu
-
-Building Eterm 0.8
-------------------
+- Version 11 of the X Window System.  I believe Release 4 is the minimum
+  required, but R6 is highly recommended.
+- The Imlib image library.  Visit http://www.enlightenment.org/ to download it
+  or for more information.
+- Eterm will work with any window manager (or no window manager at all), but it
+  is designed to work best with Enlightenment.  Some features (like auto mode
+  and similar IPC-based functions) will not work with other window managers, and
+  other WM-dependent features (like desktop selection/switching) may or may not
+  work.  That's life.
+
+Documentation
+-------------
+- The FAQ and message forum at http://eterm.i-docs.org/
+- The man page at http://www.eterm.org/
+- Running "Eterm --help" will show you the command line options.
+- The Technical Reference, also at the above web site, if you want more
+  technical details about Eterm.
+
+Building Eterm
+--------------
 
 From the toplevel Eterm source tree directory:
-    ./configure
-    make
-	
-With better optimization flags
-
- - For gcc 2.7.2.1 and older:  make "CFLAGS=-O2 -fno-strength-reduce"
- - For Intel-based platforms with new gcc compilers:  make "CFLAGS=-O2 -m486"
- - For Intel-based platforms with new gcc compilers, more optimization:
-     make "CFLAGS=-O3 -m486 -malign-loops=2 -malign-jumps=2 -malign-functions=2"
- - For Pentium machines with egcs or pgcc:
-     make "CFLAGS=-O6 -mpentium -malign-loops=2 -malign-jumps=2 -malign-functions=2"
-       - Eterm seems to compile OK with pgcc 1.0.1. DEFINITELY use the -malign
-         flags, they seem to speed things up quite considerably for Pentium
-         processors :)
+
+  ./configure
+  make
 	
 Installing Eterm
 ----------------
 
 After performing the build step above, run:
-    make install
 
-Standard Disclaimer
--------------------
+  make install
 
-The authors don't take any responsibility for any damage this program
-may do. We are doing this in our spare time. If you don't like this
-program, don't use it.
+It is very important that you perform the "make install" step rather than simply
+copying the binary into place.  The install routine does a lot more, and Eterm
+will not run properly unless you perform a proper installation.
 
-Eterm is based on rxvt 2.21. This development release of Eterm
-has been hacked together by Tuomo Venalainen (vendu@cc.hut.fi)
-and Michael Jennings (mej@tcserv.com). Thanks to Rasterman
-(aka Carsten Haitzler) and Michael Kellen, as well as to all the
-other people who have provided patches.  Thanks to all regulars 
-from the #E IRC channel for helping us test Eterm.
+On some systems, you may need to install Eterm setuid root in order for it
+to appear in a "w" or "who" listing.  This includes Debian Linux and HP-UX.
+Redhat Linux and Solaris are known to not require setuid root.  If you need
+to install Eterm setuid root, here's how:
 
-The development of Eterm will be continued. The sources need to be
-converted into human-readable format ;-). More features will be added
-as well. We'll continue cleaning up and patching the sources to make
-Eterm more robust, secure and portable.
+  chown root /usr/local/bin/Eterm
+  chmod u+s /usr/local/bin/Eterm
 
-NOTE: Support for libXpm was dropped off in DR 0.3. Imlib does a much
-      better job at loading and scaling the background pixmaps. And hey,
-      it's Eterm, ya know :-)
+If you installed into a location other than /usr/local, change the above
+paths appropriately.
 
-Future Plans
-------------
-
-There will be minimal further development on this incarnation of Eterm.
-We have begun Project Resurrection, which is a complete rewrite of Eterm
-with a completely different philosophy of design.  Please visit
-http://ganja.tky.hut.fi/Resurrection/ for more information.
-
-Notes
------
-
-- In case you need utmp support, you'll have to run Eterm "setuid root"
-  As root, do: "chmod 4755 Eterm" Make SURE the Eterm binary is owned by
-  user=root, group=root (on BSD, i think it should be group=wheel):
-
-	1. chown root.root Eterm
-	2. (BSD) chown root.wheel Eterm
-
-  Note that in this version, utmp support will be turned on automagically
-  only on Linux and FreeBSD. If you want to try it on other platforms,
-  add -DUTMP_SUPPORT to your compilation flags. An example:
-    make "CFLAGS=-O -DUTMP_SUPPORT"
-
-- The only fonts I know that will display ANSI art correctly are Raster's
-  nexus and vga;
-- If you want to use colorful ANSI prompts (at least bash can show them),
-  make sure to make them end with a new line character ('\n')>
+Standard Disclaimer
+-------------------
 
-Development Notes
------------------
+The authors don't take any responsibility for any damage this program
+may do. We are doing this in our spare time. If you don't like this
+program, don't use it.
 
-- ATTENTION! Ignore warnings like this:
-  options.c:1454: warning: unsigned int format, long unsigned int arg (arg 3)
-  - type casting or otherwise screwing around can break text colors bad :)
-- The sources don't compile with the GCC profiling flag (-gp) yet;
+Eterm was originally based on rxvt, but has been extensively modified.  In
+its current form, most parts of Eterm bear little or no resemblence to rxvt (all
+the cool parts.) :-)
 
 Troubleshooting
 ---------------
 
-- See feature.h;
-- In case you have problems, try commenting out #define NDEBUG in feature.h:
-  /* #define NDEBUG */
+Eterm has its own built-in debugging system which is enabled by the --debug
+option on the command line.  Use --debug 2 to start with; you can go all the
+way up to level 4 debugging.  Level 5 debugging slows things down a lot and is
+disabled by default.  Only serious developers should touch that one.
+
+Eterm is also capable to using gdb, dbx, and other tools to generate a stack
+trace of itself when it crashes.  This information will help developers find
+the problem.  Make sure that you compiled Eterm with the "-O0 -g3" compiler
+flags (for gcc, or the equivalent flags for your compiler) if you choose to
+submit a stack trace.
 
-E-n-Joy! ;-)   -- vendu & mej
+You'll also find people on the EFNet IRC channel #E who might be able to answer
+your questions, but please be sure you've read all the documentation mentioned
+above before asking a question there.