xref: /openbsd/usr.bin/vi/LAYOUT (revision e5dd7070)
1#	$OpenBSD: LAYOUT,v 1.7 2016/01/06 22:34:45 millert Exp $
2
3#	@(#)LAYOUT	8.12 (Berkeley) 10/10/96
4
5FAQ
6	Frequently asked questions.
7
8LAYOUT
9	This file: the layout of the nvi sources.
10
11LICENSE
12	Nvi's copyright notice and conditions for redistribution.
13
14README
15	Welcome message and basic information.
16
17build/
18	The build/configuration directory for nvi.  See build/README for
19	more information.
20
21cl/
22	Source files for nvi's curses screen support.
23
24common/
25	Source files for pieces of code that are shared by ex and vi,
26	e.g., searching and logging code or code translating line numbers
27	into requests to the dbopen(3) database code.  It also has the
28	interface code for modifying "records" in the underlying database.
29
30docs/
31	Ex/vi documentation, both current and historic.
32
33	USD.doc/
34		[USD stands for "User's Supplementary Documents".]
35
36		edit/   Roff source for "Edit: A tutorial".  This document
37			was USD:14 in the 4.3BSD manuals, but was not
38			distributed with 4.4BSD.
39
40		exref/  Roff source for "Ex Reference Manual -- Version
41			3.7".  This document was USD:16 in the 4.3BSD
42			manuals, and USD tabbed 12 in the 4.4BSD manuals.
43
44		vi.man/ Roff source for a UNIX manual page for nex/nvi.
45			An updated version of the 4.4BSD manual page.
46
47		vi.ref/ Roff source for the nex/nvi reference document.
48			An updated version of the 4.4BSD document, USD
49			tabbed 13.
50
51		vitut/  Roff source for "An Introduction to Display
52			Editing with Vi".  This document was USD:15 in
53			the 4.3BSD manuals, but was not distributed with
54			4.4BSD.  It includes the historic "Vi Quick
55			Reference" card.
56
57
58		PostScript preformatted versions of the nex/nvi reference
59		manual and manual page are in the files named with a ".ps"
60		suffix, in their respective source directories.  Flat text
61		preformatted versions of the nex/nvi reference manual and
62		manual page are in the files named with a ".txt" suffix,
63		in their respective source directories.
64
65	changelog	-- Log of changes from version to version.
66	features	-- Todo list, suggested features list.
67	internals/
68	    autowrite	-- Vi autowrite option discussion.
69	    context	-- Previous context marks discussion.
70	    gdb.script	-- GDB debugging scripts.
71	    input	-- Vi maps, executable buffers, and input discussion.
72	    openmode	-- Open mode behaviors.
73	    quoting	-- Vi quoting discussion.
74	    structures	-- Out-of-date nvi internal structure description.
75	tutorial/	-- Historic vi tutorial(s), of unknown quality.
76
77ex/
78	The ex source code.  Because vi has the colon command, lots of
79	this code is used by vi.  Generally, if functionality is shared
80	by both ex and vi, it's in the ex directory.  If it's vi only,
81	it's in the vi directory.  Files are generally named by the
82	command(s) they support, but occasionally with a name that
83	describes their functionality.
84
85	version.h	-- Version information.
86
87include/
88	Replacement include files.
89
90vi/
91	The vi source code.
92