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