contrib/ee/README.ee

   1 Copyright (c) 2009, Hugh Mahon
   2 All rights reserved.
   3
   4 Redistribution and use in source and binary forms, with or without
   5 modification, are permitted provided that the following conditions
   6 are met:
   7
   8     * Redistributions of source code must retain the above copyright
   9       notice, this list of conditions and the following disclaimer.
  10     * Redistributions in binary form must reproduce the above
  11       copyright notice, this list of conditions and the following
  12       disclaimer in the documentation and/or other materials provided
  13       with the distribution.
  14
  15 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  16 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  17 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  18 FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  19 COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  21 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  23 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  25 ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26 POSSIBILITY OF SUCH DAMAGE.
  27
  28
  29 The editor 'ee' (easy editor) is intended to be a simple, easy to use
  30 terminal-based screen oriented editor that requires no instruction to
  31 use.  Its primary use would be for people who are new to computers, or who
  32 use computers only for things like e-mail.
  33
  34 ee's simplified interface is highlighted by the use of pop-up menus which
  35 make it possible for users to carry out tasks without the need to
  36 remember commands.  An information window at the top of the screen shows
  37 the user the operations available with control-keys.
  38
  39 ee allows users to use full eight-bit characters.  If the host system has
  40 the capabilities, ee can use message catalogs, which would allow users to
  41 translate the message catalog into other languages which use eight-bit
  42 characters.  See the file ee.i18n.guide for more details.
  43
  44 ee relies on the virtual memory abilities of the platform it is running on
  45 and does not have its own memory management capabilities.
  46
  47 I am releasing ee because I hate to see new users and non-computer types
  48 get frustrated by vi, and would like to see more intuitive interfaces for
  49 basic tools (both character-based and graphical) become more pervasive.
  50 Terminal capabilities and communication speeds have evolved considerably
  51 since the time in which vi's interface was created, allowing much more
  52 intuitive interfaces to be used.  Since character-based I/O won't be
  53 completely replaced by graphical user interfaces for at least a few more
  54 years, I'd like to do what I can to make using computers with less
  55 glamorous interfaces as easy to use as possible.  If terminal interfaces
  56 are still used in ten years, I hope neophytes won't still be stuck with
  57 only vi.
  58
  59 For a text editor to be easy to use requires a certain set of abilities.  In
  60 order for ee to work, a terminal must have the ability to position the cursor
  61 on the screen, and should have arrow keys that send unique sequences
  62 (multiple characters, the first character is an "escape", octal code
  63 '\033').  All of this information needs to be in a database called "terminfo"
  64 (System V implementations) or "termcap" (usually used for BSD systems).  In
  65 case the arrow keys do not transmit unique sequences, motion operations are
  66 mapped to control keys as well, but this at least partially defeats the
  67 purpose.  The curses package is used to handle the I/O which deals with the
  68 terminal's capabilities.
  69
  70 While ee is based on curses, I have included here the source code to
  71 new_curse, a subset of curses developed for use with ee.  'curses' often
  72 will have a defect that reduces the usefulness of the editor relying upon
  73 it.
  74
  75 The file new_curse.c contains a subset of 'curses', a package for
  76 applications to use to handle screen output.  Unfortunately, curses
  77 varies from system to system, so I developed new_curse to provide
  78 consistent behavior across systems.  It works on both SystemV and BSD
  79 systems, and while it can sometimes be slower than other curses packages,
  80 it will get the information on the screen painted correctly more often
  81 than vendor supplied curses.  Unless problems occur during the building
  82 of ee, it is recommended that you use new_curse rather than the curses
  83 supplied with your system.
  84
  85 If you experience problems with data being displayed improperly, check
  86 your terminal configuration, especially if you're using a terminal
  87 emulator, and make sure that you are using the right terminfo entry
  88 before rummaging through code.  Terminfo entries often contain
  89 inaccuracies, or incomplete information, or may not totally match the
  90 terminal or emulator the terminal information is being used with.
  91 Complaints that ee isn't working quite right often end up being something
  92 else (like the terminal emulator being used).
  93
  94 Both ee and new_curse were developed using K&R C (also known as "classic
  95 C"), but it can also be compiled with ANSI C.  You should be able to
  96 build ee by simply typing "make".  A make file which takes into account
  97 the characteristics of your system will be created, and then ee will be
  98 built.  If there are problems encountered, you will be notified about
  99 them.
 100
 101 ee is the result of several conflicting design goals.  While I know that it
 102 solves the problems of some users, I also have no doubt that some will decry
 103 its lack of more features.  I will settle for knowing that ee does fulfill
 104 the needs of a minority (but still large number) of users.  The goals of ee
 105 are:
 106
 107         1. To be so easy to use as to require no instruction.
 108         2. To be easy to compile and, if necessary, port to new platforms
 109            by people with relatively little knowledge of C and UNIX.
 110         3. To have a minimum number of files to be dealt with, for compile
 111            and installation.
 112         4. To have enough functionality to be useful to a large number of
 113            people.
 114
 115 Hugh Mahon              |___|
 116 hugh4242@yahoo.com      |   |
 117                             |\  /|
 118                             | \/ |
 119