The purpose of documentation is to make Postgres easier to learn, use, and develop. The documentation set should describe the Postgres system, language, and interfaces. It should be able to answer common questions and to allow a user to find those answers on his own without resorting to mailing list support.
文書化の目的は、Postgres の学習、利用、 及び、開発をより容易にすることです。文書群は Postgres システム、言語、インタフェース についてを記述しなければなりません。それは一般的な質問を解決し、ま た、ユーザがメーリングリストによるサポートに頼らなくても独力で回答 を見つけられるようなものでなければなりません。
Postgres has four primary documentation formats:
Postgres には、次の 4 つの主な文書化形 式があります。
Plain text for pre-installation information.
インストール実施前の情報用の平文。
HTML, for on-line browsing and reference.
オンラインでの閲覧、参照用の HTML。
Hardcopy, for in-depth reading and reference.
じっくり読んで、そして参照するための印刷物。
man pages, for quick reference.
素早く参照するための、マニュアルページ
Table DG2-1. Postgres 文書成果物
| ファイル | 説明 |
|---|---|
| ./COPYRIGHT | 著作権に関する注意書き |
| ./INSTALL | インストール手順（ sgml->rtf-> テキストの順に変換された テキスト） |
| ./README | 前置きとなる情報 |
| ./register.txt | make 実行中の登録メッセージ |
| ./doc/bug.template | バグ報告用のテンプレート |
| ./doc/postgres.tar.gz | ( HTML )文書をまとめたもの |
| ./doc/programmer.ps.gz | プログラマガイド（ポストスクリプト） |
| ./doc/programmer.tar.gz | プログラマガイド（HTML） |
| ./doc/reference.ps.gz | レファレンスマニュアル（ポストスクリプト） |
| ./doc/reference.tar.gz | レファレンスマニュアル（HTML） |
| ./doc/tutorial.ps.gz | 入門（ポストスクリプト） |
| ./doc/tutorial.tar.gz | 入門（ HTML ） |
| ./doc/user.ps.gz | ユーザガイド（ポストスクリプト） |
| ./doc/user.tar.gz | ユーザガイド（HTML） |
There are man pages available, as well as a large number of plain-text README-type files throughout the Postgres source tree.
Postgres のソースツリーには、平文の README といったようなファイルと同様、多くの使用できるマニュアル ページもあります。