home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 October / usenetsourcesnewsgroupsinfomagicoctober1994disk2.iso / unix / volume26 / ee-1.23 / part01 / README < prev   
Text File  |  1993-06-20  |  5KB  |  140 lines

  1.         Easy-edit v1.23              by Larry Broda
  2. ===================================================================
  3.  
  4.     Easy-edit (or "ee") is a simple text editor for novice users.
  5. It is designed to be usable with no training at all, and it was
  6. designed primarily for a Unix user community who used the system for
  7. e-mail and little else, and are not willing or do not have the time to
  8. learn vi or emacs to edit their mail messages.  (At our installation,
  9. even computer-shy users who were afraid of Unix or vi and emacs began
  10. editing when ee was introduced.  The response from such people, who
  11. ranged from secretaries to professors, was quite positive).
  12.  
  13.     When used as the default editor in Elm, it makes for a very
  14. easy-to-use mail system requiring a mininum of user education.
  15.  
  16.     Easy-edit is a major-mode of GNU Emacs.  As such it avoids many
  17. of the screen/keyboard handling bugs in custom-written editors of this sort,
  18. as that work is actually done by Emacs.  Ee splits the editing
  19. screen into two windows; in the top window, the file is edited, and in
  20. the bottom window (called the "HELP" window), a list of editing
  21. commands is displayed.  The HELP window may be scrolled up and down to
  22. display everything the ee user needs to know to edit a file; however,
  23. usually the first HELP page contains enough to edit, and the susequent
  24. ones reveal more advanced commands.  The editor itself contains most
  25. desirable simple editing commands for insertion, deletion, searching,
  26. and even text-justification.
  27.  
  28.     Advanced users may choose a more concise HELP window display,
  29. or may eliminate the HELP window completely (the HELP window may also
  30. be shrunk to make more room for the file window).  A full-text manual
  31. can also be displayed in the HELP window.
  32.  
  33.     Easy-edit can be installed for an entire system by the system 
  34. manager, or by individuals in their own accounts for personal use, as long
  35. as the system has GNU emacs.  
  36.  
  37.     Easy-edit consists of the following files:
  38.  
  39.  
  40. easyedit.el           The Emacs-lisp program file.  When loaded into Emacs,
  41.                       easy-edit mode is enabled.
  42.  
  43. HELP-WINDOW           The default HELP window display
  44. HELP-WINDOW-ADVANCED  The advanced HELP window display 
  45. HELP-MANUAL           The full text manual HELP window display
  46.  
  47. easy-edit             The Bourne shell script file used to call
  48.                       easy-edit.  This script calls emacs with the
  49.                   arguments to bring up easy-edit mode. This
  50.                       script is generated by the makefile to use
  51.                       to the site-define directories.
  52.  
  53. ee.sh.template        The template for the sh script, used by the
  54.                       Makefile to create easy-edit.
  55.  
  56. ee                    A link to easy-edit, created by the Makefile,
  57.                       provided as a convenient abbreviation.
  58.  
  59. easy-edit.man          The man page for easy-edit
  60.  
  61. ee.license          Copyright/license info
  62.  
  63. Installation
  64. ===========
  65.  
  66. Requirements:  GNU Emacs.
  67.  
  68.     Easy-edit was designed with GNU Emacs version 18.57 and 18.58,
  69. and is untested with other versions.
  70.     Ee assumes that  it is running on a Unix system with BSD/csh
  71. type process control facilities.  Some commands may not behave properly
  72. on other types of systems (esp, ^Z, ESC D, and ESC !).
  73.  
  74.  
  75. Procedure:
  76. =========
  77.  
  78. 1. Edit the Makefile
  79.  
  80. Copy Makefile.templ to Makefile and change path variables to reflect 
  81. your system according to the instructions at the top of the file.  It
  82. is recommended that you create a new directory for EE_LIBDIR, where the
  83. program and HELP files are stored.  Be sure the full pathname for your
  84. Emacs executable is given where required.
  85.  
  86. The variable EE_RESUME_CMD should be set to reflect the command that
  87. is issued to resume a suspended process.  On most systems, it will be 
  88. probably be "fg"; if your system suspends Emacs by forking a shell, this
  89. will be "exit".  The sole purpose of this variable is to issue an 
  90. informational message to users who suspend Ee reminding them how to start
  91. it again.
  92.  
  93. Create the directories for EE_LIBDIR and EXEDIR if they do not exist.
  94.  
  95. 2. Do a "make easy-edit" 
  96.  
  97. This will create the shell script "easy-edit".
  98.  
  99. 3. Do a "make install"
  100.  
  101. This will mv easy-edit to the specified directory, create "ee", which
  102. will be a hard link to easy-edit, and copy the easyedit.el and HELP
  103. files into the EE_LIBDIR directory.
  104.  
  105. 4. If you want man pages, do a "make install-man"
  106.  
  107. 5. Give it a try.
  108.  
  109.  
  110. Easy-edit novice screen editor for Unix systems with GNU emacs
  111.  
  112.      Easy-edit 1.23
  113.  
  114.      Copyright (C) 1992     Larry Broda
  115.                             Department of Psychology
  116.                             University of Illinois at Urbana-Champaign
  117.  
  118.     This program is distributed in the hope that it will be useful, 
  119.     but WITHOUT ANY WARRANTY; without even the implied warranty of 
  120.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  This program  
  121.     is an extension of GNU emacs; See the GNU General Public License  
  122.     for more details. 
  123.  
  124.     This program is free software; you can redistribute it and/or modify
  125.     it under the same terms as the GNU General Public License as published by
  126.     the Free Software Foundation either version 1, or (at your option)
  127.     any later version.
  128.  
  129.        By Larry Broda  
  130.        Department of Psychology
  131.        University of Illinois at Urbana-Champaign
  132.        Email: lbroda@s.psych.uiuc.edu
  133.        4/13/92 
  134.  
  135.     for GNU emacs information contact:
  136.     Free Software Foundation
  137.     675 Massachusetts Avenu
  138.     Cambridge, MA 02139
  139.     USA
  140.