- Add ral(4) for Ralink RT2500/RT2501/RT2600 chip based wireless NIC
[dragonfly.git] / contrib / nvi / LAYOUT
1 #       @(#)LAYOUT      8.12 (Berkeley) 10/10/96
2
3 LAYOUT
4         This file: the layout of the nvi sources.
5
6 LICENSE
7         Nvi's copyright notice and conditions for redistribution.
8
9 README
10         Welcome message and basic information.
11
12 build/
13         The build/configuration directory for nvi.  See build/README for
14         more information.
15
16 catalog/
17         Support for message catalogs for nvi.  See catalog/README for more
18         information.
19
20 cl/
21         Source files for nvi's curses screen support.
22
23 clib/
24         Replacement source files for C library functions.
25
26 common/
27         Source files for pieces of code that are shared by ex and vi,
28         e.g., searching and logging code or code translating line numbers
29         into requests to the dbopen(3) database code.  It also has the
30         interface code for modifying "records" in the underlying database.
31
32 curses/
33         A stripped-down replacement curses library.  Do not try and use
34         this library outside of nvi, many standard curses functions have
35         been removed because nvi doesn't use them.  See build/README for
36         more information.
37
38 db/
39         A stripped-down replacement DB library.  Do not try and use this
40         library outside of nvi, many standard DB functions have been
41         removed because nvi doesn't use them.  See db/README for more
42         information.
43
44 docs/
45         Ex/vi documentation, both current and historic.
46
47         USD.doc/
48                 [USD stands for "User's Supplementary Documents".]
49
50                 edit/   Roff source for "Edit: A tutorial".  This document
51                         was USD:14 in the 4.3BSD manuals, but was not
52                         distributed with 4.4BSD.
53
54                 exref/  Roff source for "Ex Reference Manual -- Version
55                         3.7".  This document was USD:16 in the 4.3BSD
56                         manuals, and USD tabbed 12 in the 4.4BSD manuals.
57
58                 vi.man/ Roff source for a UNIX manual page for nex/nvi.
59                         An updated version of the 4.4BSD manual page.
60
61                 vi.ref/ Roff source for the nex/nvi reference document.
62                         An updated version of the 4.4BSD document, USD
63                         tabbed 13.
64
65                 vitut/  Roff source for "An Introduction to Display
66                         Editing with Vi".  This document was USD:15 in
67                         the 4.3BSD manuals, but was not distributed with
68                         4.4BSD.  It includes the historic "Vi Quick
69                         Reference" card.
70
71
72                 PostScript preformatted versions of the nex/nvi reference
73                 manual and manual page are in the files named with a ".ps"
74                 suffix, in their respective source directories.  Flat text
75                 preformatted versions of the nex/nvi reference manual and
76                 manual page are in the files named with a ".txt" suffix,
77                 in their respective source directories.
78
79         changelog       -- Log of changes from version to version.
80         features        -- Todo list, suggested features list.
81         internals/
82             autowrite   -- Vi autowrite option discussion.
83             context     -- Previous context marks discussion.
84             gdb.script  -- GDB debugging scripts.
85             input       -- Vi maps, executable buffers, and input discussion.
86             openmode    -- Open mode behaviors.
87             quoting     -- Vi quoting discussion.
88             structures  -- Out-of-date nvi internal structure description.
89         tutorial/       -- Historic vi tutorial(s), of unknown quality.
90
91 ex/
92         The ex source code.  Because vi has the colon command, lots of
93         this code is used by vi.  Generally, if functionality is shared
94         by both ex and vi, it's in the ex directory.  If it's vi only,
95         it's in the vi directory.  Files are generally named by the
96         command(s) they support, but occasionally with a name that
97         describes their functionality.
98
99         version.h       -- Version information.
100
101 include/
102         Replacement include files:
103
104         bitstring.h     -- The 4.4BSD bitstring operations.
105         sys/queue.h     -- The 4.4BSD queue operations.
106
107 perl_api/
108         Source code supporting the Perl scripting language for nvi.
109
110 perl_scripts/
111         Scripts for Perl included with nvi.
112
113 regex/
114         Henry Spencer's POSIX 1003.2 regular expression (RE) library.
115
116 tcl_api/
117         Source code supporting the Tcl scripting language for nvi.
118
119 tcl_scripts/
120         Scripts for Tcl included with nvi.
121
122 tk/
123         Source files for nvi's Tk screen support.
124
125         init.tcl        -- Vi startup tcl script.
126
127 vi/
128         The vi source code.