Annotation of src/usr.bin/vi/README, Revision 1.11
1.11 ! bentley 1: # $OpenBSD: README,v 1.10 2001/01/29 01:58:25 niklas Exp $
1.10 niklas 2:
1.9 millert 3: # @(#)README 8.149 (Berkeley) 7/14/97
1.1 deraadt 4:
1.9 millert 5: This is version 1.79 (7/14/97) of nex/nvi, a reimplementation of the ex/vi
6: text editors originally distributed as part of the Fourth Berkeley
7: Software Distribution (4BSD), by the University of California, Berkeley.
8:
9: The directory layout is as follows:
10:
1.11 ! bentley 11: FAQ ................... Frequently asked questions.
! 12: LAYOUT ................ The layout of the nvi sources.
! 13: LICENSE ............... Copyright, use and redistribution information.
! 14: README ................ This file.
! 15: catalog ............... Message catalogs; see catalog/README.
! 16: cl .................... Vi interface to the curses(3) library.
! 17: common ................ Code shared by ex and vi.
! 18: docs .................. Ex/vi documentation, both current and historic.
! 19: docs/USD.doc/edit ..... Edit: A tutorial.
! 20: docs/USD.doc/exref .... Ex Reference Manual -- Version 3.7.
! 21: docs/USD.doc/vi.man ... UNIX manual page for nex/nvi.
! 22: docs/USD.doc/vi.ref ... Nex/nvi reference manual.
! 23: docs/USD.doc/vitut .... An Introduction to Display Editing with Vi.
! 24: ex .................... Ex source code.
! 25: include ............... Replacement include files.
! 26: perl_api .............. Perl scripting language support.
! 27: perl_scripts .......... Perl scripts.
! 28: vi .................... Vi source code.
1.9 millert 29:
30: Bug fixes and updated versions of this software will periodically be made
31: available. For more information see:
32:
33: http://www.bostic.com/vi
34:
35: To ask questions about vi, report vi problems, request notification of
36: future releases and/or bug fixes, or to contact the authors for any reason,
37: please send email to:
1.1 deraadt 38:
1.9 millert 39: bostic@bostic.com
1.1 deraadt 40:
41: =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
1.2 deraadt 42: o This software is several years old and is the product of many folks' work.
1.1 deraadt 43:
1.2 deraadt 44: This software was originally derived from software contributed to
45: the University of California, Berkeley by Steve Kirkendall, the
46: author of the vi clone elvis. Without his work, this work would
47: have been far more difficult.
48:
49: IEEE POSIX 1003.2 style regular expression support is courtesy of
50: Henry Spencer, for which I am *very* grateful.
1.1 deraadt 51:
1.2 deraadt 52: Elan Amir did the original 4BSD curses work that made it possible
53: to support a full-screen editor using curses.
1.1 deraadt 54:
1.2 deraadt 55: George Neville-Neil added the Tcl interpreter, and the initial
56: interpreter design was his.
1.1 deraadt 57:
1.6 downsj 58: Sven Verdoolaege added the Perl interpreter.
1.1 deraadt 59:
1.5 michaels 60: Rob Mayoff provided the original Cscope support.
61:
62: o Many, many people suggested enhancements, and provided bug reports and
63: testing, far too many to individually thank.
1.1 deraadt 64:
65: o From the original vi acknowledgements, by William Joy and Mark Horton:
66:
67: Bruce Englar encouraged the early development of this display
68: editor. Peter Kessler helped bring sanity to version 2's
69: command layout. Bill Joy wrote versions 1 and 2.0 through 2.7,
70: and created the framework that users see in the present editor.
71: Mark Horton added macros and other features and made the editor
72: work on a large number of terminals and Unix systems.
73:
74: o And...
75: The financial support of UUNET Communications Services is gratefully
76: acknowledged.
77:
78: =-=-=-=-=-=-=-=-=-=-=
79: o Status:
80:
1.2 deraadt 81: This software is in beta test, and it's pretty stable. Almost all of the
82: historic functionality in ex/vi is there, the only major missing pieces
1.5 michaels 83: are open mode and the lisp edit option.
1.2 deraadt 84:
85: Nvi is largely 8-bit clean. This isn't difficult to fix, and was left in
86: during initial development to keep things simple. Wide character support
87: will be integrated at the same time that it is made fully 8-bit clean.
1.1 deraadt 88:
89: There aren't a lot of new features in nex/nvi, but there are a few things
1.3 mickey 90: you might like. The "Additional Features" section of the reference work
91: (docs/USD.doc/vi.ref/vi.ref.txt, docs/USD.doc/vi.ref/vi.ref.ps) has more
92: information.
1.1 deraadt 93:
94: =-=-=-=-=-=-=-=-=-=-=
95: o Debugging:
96:
1.2 deraadt 97: Code fixes are greatly appreciated, of course, but if you can't provide
98: them, please email me as much information as you can as to how I might
99: reproduce the bug, and I'll try to fix it locally. Stack traces of core
100: dumps are only rarely helpful -- an example file with a set of keystrokes
101: that causes the problem is almost invariably necessary. I know it's
102: annoying, but simply playing with the bug until you can reproduce it at
1.5 michaels 103: will, with minimal keystrokes, is immensely helpful to me.
1.1 deraadt 104:
105: Please include the following in the bug report;
106:
107: o The version of nvi you're running (use :version to get it).
108: o The row/column dimensions of the screen (80 x 32).
109: o Unless you're confident that they're not part of the problem,
110: your startup files (.exrc, .nexrc) and the environment variable
1.2 deraadt 111: (EXINIT, NEXINIT) values. (Cutting and pasting the output
1.1 deraadt 112: of ":set all" is usually sufficient.)
113:
1.2 deraadt 114: If you want to do your own debugging, recompile the program with DEBUG
115: defined. (Configuring with --enable-debug will do this for you.) This
116: turns on the additional command-line option -D, that takes either s or w
117: as an argument. The option -Ds causes nvi to ignore the EXINIT and
118: .exrc files on startup, and -Dw causes nvi to print out the process id
119: and wait for you to enter a <carriage-return> to continue.
120:
121: If you're running a memory checker (e.g. Purify) on nvi, you will first
122: want to recompile everything with "-DPURIFY" set in the CFLAGS. This
123: initializes allocated pages in the DB code, and free's allocated memory
124: at the end of the nvi execution.
![[BACK]](/icons/back.gif){kind=icon}
Return to README CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / vi