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.12

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