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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>AppendixG.Documentation</title>
<link rel="stylesheet" href="stylesheet.css" type="text/css">
<link rev="made" href="pgsql-docs@postgresql.org">
<meta name="generator" content="DocBook XSL Stylesheets V1.70.0">
<link rel="start" href="index.html" title="PostgreSQL 8.1.4 Documentation">
<link rel="up" href="appendixes.html" title="PartVIII.Appendixes">
<link rel="prev" href="cvsup.html" title="F.3.Getting The Source Via CVSup">
<link rel="next" href="docguide-toolsets.html" title="G.2.Tool Sets">
<link rel="copyright" href="ln-legalnotice.html" title="Legal Notice">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="appendix" lang="en" id="docguide">
<div class="titlepage"><div><div><h2 class="title">
<a name="docguide"></a>AppendixG.Documentation</h2></div></div></div>
<div class="toc">
<p><b>Table of Contents</b></p>
<dl>
<dt><span class="sect1"><a href="docguide.html#docguide-docbook">G.1. DocBook</a></span></dt>
<dt><span class="sect1"><a href="docguide-toolsets.html">G.2. Tool Sets</a></span></dt>
<dd><dl>
<dt><span class="sect2"><a href="docguide-toolsets.html#id900348">G.2.1. <span class="productname">Linux</span> <acronym class="acronym">RPM</acronym> Installation</a></span></dt>
<dt><span class="sect2"><a href="docguide-toolsets.html#id900413">G.2.2. FreeBSD Installation</a></span></dt>
<dt><span class="sect2"><a href="docguide-toolsets.html#id900526">G.2.3. Debian Packages</a></span></dt>
<dt><span class="sect2"><a href="docguide-toolsets.html#id900549">G.2.4. Manual Installation from Source</a></span></dt>
<dt><span class="sect2"><a href="docguide-toolsets.html#docguide-toolsets-configure">G.2.5. Detection by <code class="command">configure</code></a></span></dt>
</dl></dd>
<dt><span class="sect1"><a href="docguide-build.html">G.3. Building The Documentation</a></span></dt>
<dd><dl>
<dt><span class="sect2"><a href="docguide-build.html#id901379">G.3.1. HTML</a></span></dt>
<dt><span class="sect2"><a href="docguide-build.html#id901442">G.3.2. Manpages</a></span></dt>
<dt><span class="sect2"><a href="docguide-build.html#id901494">G.3.3. Print Output via <span class="application">JadeTex</span></a></span></dt>
<dt><span class="sect2"><a href="docguide-build.html#id901598">G.3.4. Print Output via <acronym class="acronym">RTF</acronym></a></span></dt>
<dt><span class="sect2"><a href="docguide-build.html#id902136">G.3.5. Plain Text Files</a></span></dt>
<dt><span class="sect2"><a href="docguide-build.html#id902244">G.3.6. Syntax Check</a></span></dt>
</dl></dd>
<dt><span class="sect1"><a href="docguide-authoring.html">G.4. Documentation Authoring</a></span></dt>
<dd><dl>
<dt><span class="sect2"><a href="docguide-authoring.html#id902308">G.4.1. Emacs/PSGML</a></span></dt>
<dt><span class="sect2"><a href="docguide-authoring.html#id902546">G.4.2. Other Emacs modes</a></span></dt>
</dl></dd>
<dt><span class="sect1"><a href="docguide-style.html">G.5. Style Guide</a></span></dt>
<dd><dl><dt><span class="sect2"><a href="docguide-style.html#id902594">G.5.1. Reference Pages</a></span></dt></dl></dd>
</dl>
</div>
<p> <span class="productname">PostgreSQL</span> has four primary documentation
formats:
</p>
<div class="itemizedlist"><ul type="disc">
<li><p> Plain text, for pre-installation information
</p></li>
<li><p> <acronym class="acronym">HTML</acronym>, for on-line browsing and reference
</p></li>
<li><p> PDF or Postscript, for printing
</p></li>
<li><p> man pages, for quick reference.
</p></li>
</ul></div>
<p>
Additionally, a number of plain-text <code class="filename">README</code> files can
be found throughout the <span class="productname">PostgreSQL</span> source tree,
documenting various implementation issues.
</p>
<p> <acronym class="acronym">HTML</acronym> documentation and man pages are part of a
standard distribution and are installed by default. PDF and
Postscript format documentation is available separately for
download.
</p>
<div class="sect1" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="docguide-docbook"></a>G.1.DocBook</h2></div></div></div>
<p> The documentation sources are written in
<em class="firstterm">DocBook</em>, which is a markup language
superficially similar to <acronym class="acronym">HTML</acronym>. Both of these
languages are applications of the <em class="firstterm">Standard Generalized
Markup Language</em>, <acronym class="acronym">SGML</acronym>, which is
essentially a language for describing other languages. In what
follows, the terms DocBook and <acronym class="acronym">SGML</acronym> are both
used, but technically they are not interchangeable.
</p>
<p> <span class="productname">DocBook</span> allows an author to specify the
structure and content of a technical document without worrying
about presentation details. A document style defines how that
content is rendered into one of several final forms. DocBook is
maintained by the <a href="http://www.oasis-open.org" target="_top"> OASIS group</a>. The <a href="http://www.oasis-open.org/docbook" target="_top"> official DocBook site</a> has good introductory and reference documentation and
a complete O'Reilly book for your online reading pleasure. The
<a href="http://newbiedoc.sourceforge.net/metadoc/docbook-guide.html" target="_top"> NewbieDoc Docbook Guide</a> is very helpful for beginners.
The <a href="http://www.freebsd.org/docproj/docproj.html" target="_top"> FreeBSD Documentation Project</a> also uses DocBook and has some good
information, including a number of style guidelines that might be
worth considering.
</p>
</div>
</div></body>
</html>
|
