home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / editors / pcvile.arj / README < prev    next >
Encoding:
Text File  |  1991-07-25  |  6.7 KB  |  158 lines
  1. Welcome to pcvile
  2. -----------------
  3.     This version of vile differs from the distributed source code of
  4.     vile version 3 in a few ways which I shall make clear here:
  5.     (I've included this in the help file too)
  6.  
  7.     1) The cursor keys, page up/down and insert/delete keys have been
  8.        compiled into the program (I tried binding but due to a bug this
  9.        didn't seem to work too well) so this should keep the "I don't
  10.        like using hjkl" brigade happy!
  11.  
  12.     2) Vile distinguishes between a write of a region ':1,20w' and a
  13.        write of a whole file ':w' and so each of these have been given
  14.        different letters.  The region write is ':1,20W' and the file
  15.        write remains ':w'.  ':wq' remains the same.
  16.  
  17.     3) I have implemented the emacs ^X-O command to flip between windows
  18.        as I tend to use this quite a bit rather then ^N and ^P which is
  19.        the vile standard.
  20.  
  21.     4) You can force this version of vile into one of three screen modes:
  22.        25, 43 and 50 line.  I have had problems with the 43 line mode
  23.        on AST premium 286 workstations (the only EGA I can lay my hands on)
  24.        so I apologise if it doesn't work, the 25 and 50 line modes work
  25.        fine though.  The default is 50 lines (for various reasons!) so if
  26.        you have a mono or cga monitor you'll have to change your vile.rc
  27.        file.
  28.  
  29.        There are two ways to set the screen mode:
  30.  
  31.        a) with a command line option: -2 -4 -5 are 25, 43 and 50 line resp.
  32.  
  33.        b) by adding "setg screen {25|43|50}" into your vile.rc file.
  34.           Note you should NOT do this from within the editor.
  35.  
  36.        Also, if you shell out in 50 line mode, make sure you are in 50 line
  37.        mode before you exit the dos shell, otherwise you end up with a 50
  38.        line edit window with only the top 25 displayed!
  39.  
  40.        Personally I find 50 line mode very usable, but I know people who
  41.        have difficulty reading it so just put setg screen 25 in the vile.rc
  42.        file to save your eyesight.
  43.  
  44.     5) The vile.rc file can be located in the same directory as your binary
  45.        executable, I've changed vile to search the PATH for this file.
  46.  
  47.     6) Shelling out to dos can be done by using ^Z, however this doesn't
  48.        seem to want to work if vile has run out of memory.
  49.  
  50.     There are still plenty of bugs, I know. The main one I want to get done
  51.     first being memory, ie running out. The vi compatibility isn't
  52.     100% but I like it, and I hope some others might too.
  53.  
  54.     I am taking responsibility for any pcvile bugs (please check the enclosed
  55.     known bug list first though) and I'll then split them into pc
  56.     specific, which I will deal with, and vile general bugs, which I will pass
  57.     on to Paul Fox so that they can be fixed for version 4.
  58.  
  59.     Pete Ruczynski July 19, 1991
  60.     pjr@pyra.co.uk
  61.  
  62.     Below you'll find Pauls original README document, enjoy.
  63.  
  64.  
  65.  
  66. VILE -- VI Like Emacs: a vi workalike put together from Micro-Emacs by Paul Fox
  67. -------------------------------------------------------------------------------
  68.  
  69.     This editor grew out of a frustration that although lots of
  70.     eager programmers have tackled rewrites of Emacs, with new and
  71.     better features (not to mention free source), I've not seen
  72.     anything similar done with the Second True Editor.  (The
  73.     First, of course, being /bin/ed)
  74.  
  75.     So I took a copy of MicroEmacs 3.9 (which I've since
  76.     discovered was out of date, unfortunately) and bashed and
  77.     badgered it into a vi "feel-alike".  It retains the multiple
  78.     buffer/multiple window features of uemacs, but the
  79.     "finger-feel", if you will, is very much that of vi.  It is
  80.     definitely not a clone, in that some substantial stuff is
  81.     missing, and the screen doesn't look quite the same.  But what
  82.     matters most is that one's "muscle memory" does the right thing
  83.     to the text in front of you, and that is what vile tries to do
  84.     for vi users.   THIS IS NOT A "CLONE"!
  85.  
  86.     This is the first really public version of vile.  It is
  87.     version three.  Users of previous versions will hopefully find
  88.     the additions of ":" command line ranges and the ! filter
  89.     operator helpful. 
  90.  
  91.     The collective developers of Micro-Emacs should be
  92.     complimented that the changes were as easy as they were.  The
  93.     code was pretty clean and well designed before I started on
  94.     it.  I'm not sure that the same can be said anymore... 
  95.  
  96.     The benefits over standard vi include:
  97.         - multiple files open at once
  98.         - multiple windows on the screen
  99.         - a larger set of operator commands
  100.         - the possibility of porting to your favorite micro.
  101.             (mind you, I haven't even tried this on a small
  102.                 UNIX machine, let alone DOS etc...)
  103.         - more uniform undo/yank register treatment
  104.         - using tags doesn't lose your last search pattern
  105.         - "next error" cursor positioning after compilation
  106.     Of course, it _may_ lack some of vi's reliability. :-)
  107.  
  108.     ( Although I can't imagine the emacs folks wanting to buy much
  109.     of this stuff back (insert mode, anyone? :-), they might
  110.     want to look at:
  111.         - full global undo
  112.         - tags support
  113.         - better (maybe?) UNIX terminal handling
  114.         - better UNIX shell escapes
  115.         - terminal scroll support
  116.         - multiple yank registers (formerly called kill buffers)
  117.         - multiple marks  (actually kind of messy)
  118.         - improved aesthetics of window splitting and deleting
  119.         - "next error" cursor positioning
  120.         - list mode )
  121.  
  122.     Take a look at vile.hlp for more information about features
  123.     and differences. 
  124.  
  125.     In general, I suspect that the quality of the code is roughly
  126.     on a par with MicroEmacs.  I've been using vile regularly under
  127.     both SunOS and 386 UNIX for about a year, with no major problems
  128.     (that havn't been fixed).  Another dedicated user has been
  129.     running it on various flavors of 386 UNIX (Bell, Open DeskTop,
  130.     Xenix) and Ultrix, also with no problems.
  131.  
  132.     I have not tried this on a small system, or even _any_
  133.     non-UNIX system.  I'm sure work will be required to make
  134.     it work on DOS again, for instance -- especially for spawning
  135.     sub-shells, etc. 
  136.  
  137.     I ifdef'ed out the language features (user-defined procs,
  138.     etc.) a long time ago -- I don't know if they still work,
  139.     though I didn't actively try to break them. 
  140.  
  141.     If anyone is interested in doing major work on this thing, let me
  142.     know -- I have some ideas on how to make a full ex mode work, for 
  143.     instance, and on how to add the ":map" command.  Also, take a look 
  144.     at the buglist...
  145.  
  146.     Hope you enjoy -- 
  147.  
  148.     Paul G. Fox    June 3, 1991
  149.     pgf@cayman.com
  150.  
  151. p.s.  The code distributed with vile in the "shortnames" subdirectory
  152.     is covered by GNU Public License.  The vile code itself in the
  153.     upper level directory is _not_ covered by the GNU public license. 
  154.  
  155. p.p.s By the way, I'm _not_ the same Paul Fox who wrote Crisp, the Brief
  156.     work-alike.
  157.  
  158.