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