後でいくつかのフラグが必要なコマンドライン引数があり、これをマニュアルページ引数リストにリストとして含めたいと思います。
現在私は単にFlag - Description
(マニュアルページ) しかし、これは次の理由で理想的ではありません。
- インデントや改行はありません。手動でインデントできますが、その後、設定されたコンソール幅を想定する必要がありますが、これは望ましくありません。
- 次の行に移動するために二重改行文字に依存する必要がある場合は、同様のものを使用したいと思います
.TP
。
答え1
- リストはで始まり、
.RS
で終わります.RE
。 - termで始まる項目を一覧表示します
.IP
。複数の単語を含む場合は、その用語を二重引用符で囲みます。 - リスト項目の開始後、次の行に説明テキストを配置します。
- ネスト可能なので、説明にさらにリストを含めることができます。
\fB
。代わりに..を使用する\fP
太い用語.B
(下線にも同じ -\fI
.\fP
代わりに..を使用.I
)
.RS
.IP \fBA\fP
\- Flag 1
.IP \fBB\fP
\- Flag 2
.IP \fBC\fP
\- A slightly longer flag description that could take up more than the width
of the average console. In fact you'd need a very wide console to read all
this.
.RE
生産性を向上させるには、マニュアルページをより使いやすい形式で作成して変換することをお勧めします。いくつかの適切なツールは次のリストにリストされています。スクリプトのマニュアルページを作成できますか?。