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