README

   1 #       $Id: README,v 8.36 1994/01/02 17:02:31 bostic Exp $ (Berkeley) $Date: 1994/01/02 17:02:31 $
   2
   3 This is the README for version 0.94 of nex/nvi, a (soon to be) freely
   4 redistributable replacement for the vi/ex text editors.
   5
   6 This is still ALPHA software, please do not redistribute it without
   7 talking to me first.  It can be retrieved via anonymous ftp from
   8 vangogh.cs.berkeley.edu:~ftp/hidden/nvi.tar.Z.
   9
  10 A BETA version will be released RSN, and it will be redistributable
  11 as you choose.  The beta version and future versions of this software
  12 will be available by anonymous ftp from ftp.cs.berkeley.edu, in the
  13 file ucb/4bsd/nvi.tar.Z, or from ftp.uu.net.
  14
  15 If you have any questions or problems with nvi, please send them to
  16 me by email at one of the following email addresses:
  17
  18         uunet!bostic
  19         bostic@cs.berkeley.edu
  20
  21 Keith Bostic
  22 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  23
  24 o Credit where it's due:
  25
  26         This software was originally derived from software contributed
  27         to the University of California, Berkeley by Steve Kirkendall,
  28         the author of the vi clone elvis.  Without his work, this work
  29         would have been far more difficult.
  30
  31         POSIX 1003.2 style regular expression support is courtesy of
  32         Henry Spencer, for which I am *very* grateful.
  33
  34         The reworked 4BSD curses implementation was done by Elan Amir
  35         while at the University of California, Berkeley.
  36
  37 o From the original vi acknowledgements, by William Joy and Mark Horton:
  38
  39         Bruce Englar encouraged the early development of this display
  40         editor.  Peter Kessler helped bring sanity to version 2's
  41         command layout.  Bill Joy wrote versions 1 and 2.0 through 2.7,
  42         and created the framework that users see in the present editor.
  43         Mark Horton added macros and other features and made the editor
  44         work on a large number of terminals and Unix systems.
  45
  46 =-=-=-=-=-=-=-=-=-=-=
  47 o Comments:
  48
  49 This software is alpha software, although it's pretty stable.  I believe
  50 that almost all of the necessary functionality for ex/vi is in it, now.
  51
  52 Code fixes are, of course, very much appreciated, but if you don't have
  53 time, please send me as much information as you can as to how to
  54 reproduce the bug, and I'll fix it here.  In particular, the screen
  55 routines are nasty stuff, and you probably don't want to mess with them.
  56 Stack traces of core dumps are helpful, but an example file with a set
  57 of keystrokes is far better.
  58
  59 Nvi is mostly 8-bit clean.  This isn't difficult to fix, and was left in
  60 during initial development to make things easier.  Wide character support
  61 will be integrated at the same time it is made fully 8-bit clean.
  62
  63 =-=-=-=-=-=-=-=-=-=-=
  64 o New features:
  65
  66 There aren't a lot of new features in nex/nvi, but there are a few
  67 things you might like:
  68
  69         o 8-bit clean data, practically infinite lines/files.
  70                 ^Vx[0-9A-Fa-f]* in input mode will insert any
  71                 legal character value.
  72         o Split screens:
  73                 :sp[lit] [file ...] splits the screen.
  74                 ^W switches between screens.
  75                 :resize count grows/shrinks the current screen.
  76         o Background/foreground screens
  77                 :bg backgrounds the current screen.
  78                 :di[splay] s[creens] lists the hidden screens.
  79                 :fg [file] foregrounds the specified (or next) screen.
  80         o Shell screens:
  81                 :sc[ript] [file ...] runs a shell in the screen.
  82                 Carriage return sends a line to the shell.
  83         o Buffer, screens, tags display:
  84                 :di[splay] b[uffers] displays the current cut buffers.
  85                 :di[splay] s[creens] displays the hidden screen names.
  86                 :di[splay] t[ags] displays the current tags stack.
  87         o Tag stacks:
  88                 ^T returns to previous tag location.
  89                 :tagpop [number | file] returns to previous tag location,
  90                      or, optionally tag #N, or the tag in a specific file.
  91                 :tagtop returns to first tag location.
  92         o Infinite undo:
  93                 :set nundo toggles this behavior.
  94                 u un-does the previous operation.
  95                 U re-does the next operation.
  96         o Usage information:
  97                 :exu[sage] [cmd] for ex commands.
  98                 :viu[sage] [key] for vi commands.
  99                 :help
 100         o Extended RE expressions:
 101                 :set extended turns on extended RE's, so you can
 102                     do "/in|or" and search for the next occurrence of
 103                     more than one expression.
 104         o Word search:
 105                 ^A searches for the word referenced by the cursor.
 106         o Number increment:
 107                 # increments the number referenced by the cursor.
 108         o Previous file:
 109                 :prev[ious][!] edits the previous file from the
 110                 argument list.
 111
 112 =-=-=-=-=-=-=-=-=-=-=
 113 o Porting information:
 114
 115 The directory PORT has directories per machine/OS combination, with
 116 old-style Makefiles which build nvi.  See the file PORT/README for
 117 more detailed information.
 118
 119 =-=-=-=-=-=-=-=-=-=-=
 120 o Directories:
 121
 122 The main directory, nvi, contains source files for pieces of code that
 123 are shared by all the editors, like searching and logging code or code
 124 translating line numbers into requests to the dbopen(3) database code.
 125 It also has the code for adding, deleting, and changing "records" in
 126 the underlying database.
 127
 128 nvi/docs:
 129         The nvi/docs directory has technical information about data
 130         structures and some of the trickier parts of vi like quoting,
 131         key mapping, input queues, and executing buffers, and a
 132         description of how nvi does edit session recovery.
 133
 134 nvi/ex:
 135         The nvi/ex directory is the ex source code.  Because vi has the
 136         colon command, lots of this code is used by vi.  Generally, if
 137         functionality is shared by both ex and vi, it's in nvi/ex, if
 138         it's vi only, it's in nvi/vi.  Files are generally named by the
 139         command(s) they support, but occasionally with a name that
 140         describes their functionality.
 141
 142 nvi/sex:
 143         The nvi/sex directory is the screen support for the ex editor.
 144
 145 nvi/svi:
 146         The nvi/svi directory is the screen support for a curses based
 147         vi editor.
 148
 149 nvi/vi:
 150         The nvi/vi directory is the vi source code.
 151
 152 nvi/xaw:
 153         Place reserved for an X11 (Athena Widget) screen.