Return to LAYOUT CVS log

Up to [local] / src / usr.bin / vi

Annotation of src/usr.bin/vi/LAYOUT, Revision 1.5

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