web-dev-qa-db-ja.com

manページのSYNOPSISセクションの仕様はありますか?

私は小さなチーム間で共有されるいくつかの仕様を書き込もうとしていて、いくつかのコマンドリストを配置する形式に気を配っています。manのSYNOPSISセクションで使用される構文のformal定義はありますかページ?

ウィキメディアコモンズから、これは私が話している概要セクションのあるマニュアルページの例です。ここでは、コマンドが理解できる必須およびオプションの引数とともにリストされています。

Unix manual page on the "man" command

32
wersimmon

POSIX標準でも、マンページの正式な定義はどこにもありません。例のman(1)マンページは非常に典型的です。プログラムを使用できるさまざまな方法(多くの場合1つだけ)を_[]_で記述し、オプションの太字(または-を使用したタイプライターフォント)を示します。 mdoc マクロ)リテラルコマンドライン入力を示し、斜体は変数を示します。

マンページman(7)およびmdoc(7)は、最も重要な規則を説明します。 man(7)は古いスタイルのUnixマンページ用であり、Linuxでも人気があります(man-pages(7)を参照)。 mdoc(7)は4.4BSDから来ており、その派生物で人気があります。後者は、コンテンツとプレゼンテーションのより厳密な分離を維持し、(IMHO)よりきれいなPDF/HTML出力を生成できます

18
Fred Foo

man 7 man-pages:

コマンドまたは関数のインターフェースについて簡単に説明します。コマンドの場合、これはコマンドの構文とその引数(オプションを含む)を示します。 太字はそのままのテキストに使用され、斜体は置換可能な引数を示すために使用されます。角かっこ([])はオプションの引数を囲み、垂直バー(|)は個別の選択肢であり、省略記号(...)は繰り返すことができます。関数の場合、必要なデータ宣言または#includeディレクティブが表示され、その後に関数宣言が続きます。

12
Amos Folarin

ユーティリティのユーティリティ規則は、 第12章IEEE Std 1003.1、2004 Editionのユーティリティ規則 に記載されています。

このドキュメントの新しいエディションが存在します ここ

11
Mats Kindahl