Reference pages should follow a standard layout. This allows users to find the desired information more quickly, and it also encourages writers to document all relevant aspects of a command. Consistency is not only desired among <productname>PostgreSQL</productname> reference pages, but also with reference pages provided by the operating system and other packages. Hence the following guidelines have been developed. They are for the most part consistent with similar guidelines established by various operating systems. リファレンスページは標準のレイアウトに従う必要があります。 このことにより、ユーザが必要な情報を素早く見つけられるようになり、同時にあるコマンドに関連する全ての特徴を文書化するよう書き手を励ましてもいます。 一貫性は、PostgreSQLの各リファレンスページ間だけでなく、オペレーティングシステムや他のパッケージソフトのリファレンスページとの関係でも求められるものです。 そのために、以下のガイドラインが作成されました。 このガイドラインのほとんどの部分は、様々なオペレーティングシステムで定められている同様のガイドラインと一貫性を持つものです。
Reference pages that describe executable commands should contain the following sections, in this order. Sections that do not apply can be omitted. Additional top-level sections should only be used in special circumstances; often that information belongs in the <quote>Usage</quote> section. 実行可能なコマンドを説明するリファレンスページには、以下の節がこの順序で含まれる必要があります。 該当しない節は除外しても構いません。 これらと同レベルの節は特殊な状況でのみ追加すべきです。 そのような情報は多くの場合、「使用方法」節に入れることができます。
This section is generated automatically. It contains the command name and a half-sentence summary of its functionality. この節は自動的に生成されます。ここには、コマンドの名前および機能の簡単な概要が入ります。
This section contains the syntax diagram of the command. The synopsis should normally not list each command-line option; that is done below. Instead, list the major components of the command line, such as where input and output files go. この節にはコマンドの構文図が入ります。 この概要には、通常、各コマンドラインオプションを記載しません（それらは、以下の節に記載されます）。 その代わり、入出力ファイルの宛先などのコマンドラインの主要なコンポーネントを記載します。
Several paragraphs explaining what the command does. コマンドによって何が行われるかを説明する文章です。
A list describing each command-line option. If there are a lot of options, subsections can be used. 各コマンドラインオプションについて説明するリストです。 オプションが数多くある場合、副節を使用することができます。
If the program uses 0 for success and non-zero for failure, then you do not need to document it. If there is a meaning behind the different non-zero exit codes, list them here. 成功の場合はゼロを使用し、失敗の場合には非ゼロを使用するプログラムでは、この節を記載する必要はありません。 複数の非ゼロの終了コードに異なる意味があれば、ここに記載します。
Describe any sublanguage or run-time interface of the program. If the program is not interactive, this section can usually be omitted. Otherwise, this section is a catch-all for describing run-time features. Use subsections if appropriate. プログラムの副言語またはランタイムインタフェースを全て記載します。 プログラムが対話型でない場合、通常はこの節を除外することができます。 それ以外の場合、この節は実行時の特徴のすべてを記載するために使用されます。 必要に応じて副節を作成してください。
List all environment variables that the program might use.
Try to be complete; even seemingly trivial variables like
<envar>SHELL</envar> might be of interest to the user.
プログラムが使用する可能性のある全ての環境変数を列挙します。
なるべく完全なリストを作成してください。
SHELLのような些細に見える変数でも、ユーザに必要なことがあります。
List any files that the program might access implicitly. That is, do not list input and output files that were specified on the command line, but list configuration files, etc. プログラムが暗黙的にアクセスする可能性のある全てのファイルを列挙します。 つまり、コマンドラインで指定された入出力ファイルではなく、設定ファイルなどを列挙するということです。
Explain any unusual output that the program might create. Refrain from listing every possible error message. This is a lot of work and has little use in practice. But if, say, the error messages have a standard format that the user can parse, this would be the place to explain it. プログラムが作成する可能性のある全ての異常な出力についての説明を記載します。 全てのエラーメッセージを列挙することは避けてください。 作業が大変な割に、実際にはほとんど役に立たないからです。 ただし、エラーメッセージにユーザが解析できる標準のフォーマットがあれば、ここに記載してください。
Anything that doesn't fit elsewhere, but in particular bugs, implementation flaws, security considerations, compatibility issues. 特定の不具合、実装の問題点、セキュリティの考慮事項、互換性の問題など、他の節に該当しない全てのものを記載します。
Examples 例を記載します。
If there were some major milestones in the history of the program, they might be listed here. Usually, this section can be omitted. プログラムの更新履歴に主要な変更点があった場合、ここに列挙します。 通常この節は省くことができます。
Author (only used in the contrib section) 作者（contrib節のみ使用）
Cross-references, listed in the following order: other <productname>PostgreSQL</productname> command reference pages, <productname>PostgreSQL</productname> SQL command reference pages, citation of <productname>PostgreSQL</productname> manuals, other reference pages (e.g., operating system, other packages), other documentation. Items in the same group are listed alphabetically. 次の順序で列挙されるクロスリファレンスです。 他のPostgreSQLコマンドのリファレンスページ、PostgreSQLのSQLコマンドのリファレンスページ、PostgreSQLマニュアルの引用、他のリファレンスページ（オペレーティングシステム、他のパッケージソフトなど）、その他の文書。同一グループに属するものは、アルファベット順に列挙します。
Reference pages describing SQL commands should contain the following sections: Name, Synopsis, Description, Parameters, Outputs, Notes, Examples, Compatibility, History, See Also. The Parameters section is like the Options section, but there is more freedom about which clauses of the command can be listed. The Outputs section is only needed if the command returns something other than a default command-completion tag. The Compatibility section should explain to what extent this command conforms to the SQL standard(s), or to which other database system it is compatible. The See Also section of SQL commands should list SQL commands before cross-references to programs. SQLコマンドを説明するリファレンスページには、次の節を含める必要があります。 名前、概要、説明、パラメータ、使用方法、診断、注釈、例、互換性、更新履歴、関連項目。 パラメータ節はオプション節と似ていますが、リストに加えることのできるコマンドの句についてより自由度が高いものです。 互換性節では、このコマンドがどの程度まで標準SQLに準拠しているか、または、他のどのデータベースシステムに対して互換性があるかを説明します。 SQLコマンドの関連項目節では、プログラムへのクロスリファレンスよりも前にSQLコマンドを記載する必要があります。