src/usr.bin/vi/README - annotate

Return to README CVS log

Up to [local] / src / usr.bin / vi

Annotation of src/usr.bin/vi/README, Revision 1.13

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