PHP Manual

PEAR Manual

Smarty Manual

PostgreSQL

MySQL Manual

Perl Manual

postgresql 8.2devel documentation
prevfast backwardfast forwardnext

appendix g. documentation

table of contents
g.1. docbook
g.2. tool sets
g.3. building the documentation
g.4. documentation authoring
g.5. style guide

postgresql has four primary documentation formats:

  • plain text, for pre-installation information

  • html, for on-line browsing and reference

  • pdf or postscript, for printing

  • man pages, for quick reference.

additionally, a number of plain-text readme files can be found throughout the postgresql source tree, documenting various implementation issues.

html 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.

g.1. docbook

the documentation sources are written in docbook, which is a markup language superficially similar to html. both of these languages are applications of the standard generalized markup language, sgml, which is essentially a language for describing other languages. in what follows, the terms docbook and sgml are both used, but technically they are not interchangeable.

docbook 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 oasis group. the official docbook site has good introductory and reference documentation and a complete o'reilly book for your online reading pleasure. the newbiedoc docbook guide is very helpful for beginners. the freebsd documentation project also uses docbook and has some good information, including a number of style guidelines that might be worth considering.

prevhomenext
getting the source via cvsupuptool sets