summaryrefslogtreecommitdiff
path: root/share/doc/README
blob: 96458e9a4ac0074d209c2ec2d8f4414391ee9ef7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
#	$OpenBSD: README,v 1.5 2008/06/07 01:59:36 jdixon Exp $
# 
#  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, httpd, lynx, and milter
	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).

Note: Some of the subdirectories are empty, for a variety of reasons:
the papers are simply out of date; the papers refer to applications no
longer installed on the system; licensing issues; the papers have been
superseded by GNU info(1) files, etc.