Return to README CVS log

Up to [local] / src / share / doc

Annotation of src/share/doc/README, Revision 1.1

1.1     ! jmc         1: #
        !             2: #  Copyright (c) 2004 Jason McIntyre <jmc@openbsd.org>
        !             3: #
        !             4: #  Permission to use, copy, modify, and distribute this software for any
        !             5: #  purpose with or without fee is hereby granted, provided that the above
        !             6: #  copyright notice and this permission notice appear in all copies.
        !             7: #
        !             8: #  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
        !             9: #  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
        !            10: #  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
        !            11: #  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
        !            12: #  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
        !            13: #  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
        !            14: #  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
        !            15: #
        !            16:
        !            17: The documents in this directory consist of various, miscellaneous, system docs:
        !            18:
        !            19:        html/           HTML documents for bind, curses, and lynx
        !            20:        psd/            UNIX Programmer's Supplementary Documents
        !            21:        smm/            UNIX System Manager's Manuals
        !            22:        usd/            UNIX User's Supplementary Documents
        !            23:
        !            24: The documentation in the psd, smm, and usd subdirectories are roff source,
        !            25: and can be used to generate documents in any of the formats available to the
        !            26: groff(1) document formatting system.
        !            27:
        !            28: Within any given subdirectory, simply typing:
        !            29:
        !            30:        # make
        !            31:
        !            32: will generate a pre-formatted document in PostScript format, called `paper.ps'.
        !            33: The document can be viewed with the help of a PostScript viewer, such as
        !            34: `ghostview' or `gv', and the PostScript back-end `ghostscript'. See ports(7)
        !            35: and packages(7) for further information on how to install this software.
        !            36:
        !            37: ASCII text format documents, suitable for viewing with a pager such as
        !            38: less(1), can be generated by typing:
        !            39:
        !            40:        # make paper.txt
        !            41:
        !            42: However, the PostScript output is much prettier :)
        !            43:
        !            44: The documentation in the html subdirectory can by viewed using any HTML-capable
        !            45: browser such as lynx(1).