Приложение I. Документация
- Содержание
- I.1. DocBook
- I.2. Инструментарий
- I.3. Сборка документации
- I.4. Написание документации
- I.5. Руководство по стилю
- I.1. DocBook
Документация PostgreSQL публикуется в четырёх основных форматах:
Простой текст, для информации перед установкой
HTML, для справки, поиска и просмотра в Интернете
PDF или PostScript, для печати
Страницы руководства man, для быстрой справки.
Кроме того, в дереве исходного кода PostgreSQL можно найти несколько простых текстовых файлов README, освещающих различные вопросы реализации.
Документация в HTML и страницы man входят в состав стандартного дистрибутива и устанавливаются по умолчанию. Документацию в форматах PDF и PostScript можно загрузить отдельно.
| Пред. | Начало | След. |
| Получение исходного кода из Git | Уровень выше | DocBook |
Appendix J. Documentation
- Table of Contents
- J.1. DocBook
- J.2. Tool Sets
- J.3. Building The Documentation
- J.4. Documentation Authoring
- J.5. Style Guide
- J.1. DocBook
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.