diff options
| -rw-r--r-- | share/doc/Makefile | 7 | ||||
| -rw-r--r-- | share/doc/README | 45 |
2 files changed, 51 insertions, 1 deletions
diff --git a/share/doc/Makefile b/share/doc/Makefile index eeceb2579f5..0134244e668 100644 --- a/share/doc/Makefile +++ b/share/doc/Makefile @@ -1,8 +1,13 @@ -# $OpenBSD: Makefile,v 1.2 1996/04/22 01:26:37 deraadt Exp $ +# $OpenBSD: Makefile,v 1.3 2004/02/12 10:03:31 jmc Exp $ # @(#)Makefile 8.1 (Berkeley) 6/5/93 +FILES= README SUBDIR= psd smm usd all depend includes lint tags: +realinstall: + install -c -o ${DOCOWN} -g ${DOCGRP} -m ${DOCMODE} ${FILES} \ + ${DESTDIR}${DOCDIR} + .include <bsd.subdir.mk> diff --git a/share/doc/README b/share/doc/README new file mode 100644 index 00000000000..64833fb67d1 --- /dev/null +++ b/share/doc/README @@ -0,0 +1,45 @@ +# +# Copyright (c) 2004 Jason McIntyre <jmc@openbsd.org> +# +# Permission to use, copy, modify, and distribute this software for any +# purpose with or without fee is hereby granted, provided that the above +# copyright notice and this permission notice appear in all copies. +# +# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +# + +The documents in this directory consist of various, miscellaneous, system docs: + + html/ HTML documents for bind, curses, and lynx + psd/ UNIX Programmer's Supplementary Documents + smm/ UNIX System Manager's Manuals + usd/ UNIX User's Supplementary Documents + +The documentation in the psd, smm, and usd subdirectories are roff source, +and can be used to generate documents in any of the formats available to the +groff(1) document formatting system. + +Within any given subdirectory, simply typing: + + # make + +will generate a pre-formatted document in PostScript format, called `paper.ps'. +The document can be viewed with the help of a PostScript viewer, such as +`ghostview' or `gv', and the PostScript back-end `ghostscript'. See ports(7) +and packages(7) for further information on how to install this software. + +ASCII text format documents, suitable for viewing with a pager such as +less(1), can be generated by typing: + + # make paper.txt + +However, the PostScript output is much prettier :) + +The documentation in the html subdirectory can by viewed using any HTML-capable +browser such as lynx(1). |