]> begriffs open source - ai-pg/blob - full-docs/txt/docguide.txt
Convert HTML docs to more streamlined TXT
[ai-pg] / full-docs / txt / docguide.txt
1
2 Appendix J. Documentation
3
4    Table of Contents
5
6    J.1. DocBook
7    J.2. Tool Sets
8
9         J.2.1. Installation on Fedora, RHEL, and Derivatives
10         J.2.2. Installation on FreeBSD
11         J.2.3. Debian Packages
12         J.2.4. macOS
13         J.2.5. Detection by configure
14
15    J.3. Building the Documentation with Make
16
17         J.3.1. HTML
18         J.3.2. Manpages
19         J.3.3. PDF
20         J.3.4. Syntax Check
21
22    J.4. Building the Documentation with Meson
23    J.5. Documentation Authoring
24
25         J.5.1. Emacs
26
27    J.6. Style Guide
28
29         J.6.1. Reference Pages
30
31    PostgreSQL has four primary documentation formats:
32      * Plain text, for pre-installation information
33      * HTML, for on-line browsing and reference
34      * PDF, for printing
35      * man pages, for quick reference.
36
37    Additionally, a number of plain-text README files can be found
38    throughout the PostgreSQL source tree, documenting various
39    implementation issues.
40
41    HTML documentation and man pages are part of a standard distribution
42    and are installed by default. PDF format documentation is available
43    separately for download.