Index of /ce/

,,<barszcz> Yes, I know, vi is the best. But you know what? They recently
            invented editors in which in order to write something, you
   	        just have to type it on keyboard!''
	                              (anonymous #linuxpl @ IRCnet user)

1. OVERVIEW

  'ece' is a standalone variation of CoolEdit, an editor originally from
Midnight Commander. In addition to standard 'mcedit' features, 'ece' offers
multiple file editing and possibility to reconfigure key bindings and menus;
besides, the default color scheme is not-so-blue, and the infamous 'fake half
tabs' option is disabled by default :)

2. REQUIREMENTS AND LIMITATIONS

 * gcc, libc 
 * optionally: libgpm
 * libncurses

  Currently, ece is not at all portable - it was tested only on some setups:
  + Linux   (shaerrawedd 2.4.19-xfs #7 Fri Oct 4 18:18:38 CEST 2002 i686 unknown)
  + SunOS   (atlantis 5.9 Generic_112233-04 sun4u sparc SUNW,Ultra-5_10)
  + OpenBSD (pantera 3.3 PANTERA#0 i386)
  Anyway, porting ece (and making a nice ./configure) script does not seem 
to be a difficult task - but I personally am not going to do it because
of lack of resources and motivation...

3. INSTALLATION

 * edit Makefile, change LIBDIR (responsible for location of optional 
     system-wide ece configuration files), uncomment the right setting
	 for your system...
 * do a 'make'
 * if everythig goes right, copy the ece binary to a desired location,
   for instance /usr/local/bin
 * optionally, read the FILES section to learn about ece configuration files  
 * in order to get syntax highlighting working for all system users, 
   copy the syntax subdirectory into LIBDIR (ie. create files like
   LIBDIR/syntax/c.syntax, etc.); you may also enable the syntax
   highlighting for a single user, just copy the contents of syntax
   subdirectory into ~/.cedit (ie. create files like ~/.cedit/c.syntax),
   where ~ is your home directory...
   
4. USAGE

  The user interface is rather intuitive. The labels at the bottom refer
to function keys, for instance '2 Save' means that F2 will save the current
buffer contents.... Just run 'ece', play for a while. If you don't like
the default key bindings or menus, see the next section.

  WARNING: The error 'Syntax error in file (...)Syntax on line (...)' usually
means that either you have outdated Syntax file in ~/.cedit (from old
installation of mc - in that case, just rm -f it) or you want syntax
highlighting (which is by default turned on ;) and don't
have all the needed includes. See the last point in INSTALLATION.

  WARNING: In case you use ece under putty and screen, make sure that
your ncurses understand the F-keycodes. Usually this means setting
Function Keys: xterm-r6 in putty options. You may also use CTRL F, n,
instead of Fn.

5. FILES

  YOU DO NOT NEED TO CREATE ANY CONFIGURATION FILES TO RUN ECE.
  
  However it's always possible to tune ece and adjust it to your needs using
  these files, stored either in ~/.cedit or LIBDIR:
  
  cooledrc            - contains editor basic settings; auto-generated,
                        to change a value just use the 'options' dialog
                        in ece (f9 -> Options -> General...)

  keymap              - keyboard mapping; see samples/keymap.* for sample
                        mappings, samples/keymap.default contains also
                        some hints on how to create your own keymap file
			
  menu                - menus; see samples/menu.*
  
  Syntax              - syntax highlighting configuration file. Autogenerated,
                        but of course you may always tune it.

  ~/.cedit/*.syntax or LIBDIR/syntax/*.syntax - syntax includes, defining
                        particular syntax highlighting rules for various
                        file types.

  ~/.cedit/cooledit.filepos - stores line numbers in last visited files;
                        when the 'Store file positions' option is turned
                        on, ece will automatically 'jump' to last visited
                        line when opening a file.

6. AUTHORS, ACKNOWLEDGEMENTS

  The person responsible for this package and mentioned enhancements is
  $me - Mateusz 'mteg' Golicz <mtg@elsat.net.pl>

  ece is mainly based on code from cooled-0.5 by Steve Grundell
  <cooled@grundell.u-net.com>, which seemed to be the first attempt to
  make a standalone 'mcedit'. Additionally, some parts were updated using
  code from mc-4.1.35-A11 by A'rpi <arpi@esp-team.scene.hu>. Of course,
  both of these programs were based on the original Midnight Commander,
  a great file manager, which can be found at http://www.ibiblio.org/mc/.

7. LICENSE

  The package is licensed on GNU General Public License. See COPYING file.

Mateusz 'mteg' Golicz <mtg@elsat.net.pl>