私は小さなチーム間で共有されるいくつかの仕様を書き込もうとしていて、いくつかのコマンドリストを入れるフォーマットについて気を配っています。manページのSYNOPSISセクションで使用される構文の正式な定義はありますか？
ウィキメディア・コモンズから、これは私が話している概要セクションのあるマニュアルページの例です。ここでは、コマンドが理解できる必須およびオプションの引数とともにリストされています。
17258 次
3 に答える
23
POSIX標準でも、マンページの正式な定義はどこにもありません。このman(1)例のマンページは非常に典型的なものです。プログラムのさまざまな使用方法（多くの場合1つだけ）を、[]オプションの太字（またはmdocマクロ付きのタイプライターフォント）を示し、リテラルコマンドライン入力を示し、斜体を変数として示します。
マンページman(7)とmdoc(7)は、最も重要な規則を説明します。man(7)古いスタイルのUnixマンページ用であり、Linuxでも人気があります（を参照man-pages(7)）。mdoc(7)4.4BSDに由来し、その派生物で人気があります。後者は、コンテンツとプレゼンテーションのより厳密な分離を維持し、（IMHO）よりきれいなPDF/HTML出力を生成できます
于 2012-01-03T17:22:01.260 に答える
14
ユーティリティのユーティリティ規則は、第12章に記載されています。IEEEStd1003.1、2004Editionのユーティリティ規則。
このドキュメントの新しい版はここにあります
于 2013-02-25T08:33:53.490 に答える
14
man 7 man-pages：
コマンドまたは関数のインターフェースについて簡単に説明します。コマンドの場合、これはコマンドの構文とその引数（オプションを含む）を示します。太字は現状のテキストに使用され、斜体は置換可能な引数を示すために使用されます。角かっこ（[]）はオプションの引数を囲み、縦棒（|）は選択肢を区切り、省略記号（...）は繰り返すことができます。関数の場合、必要なデータ宣言または#includeディレクティブが表示され、その後に関数宣言が続きます。
于 2013-05-15T15:35:09.220 に答える