web-dev-qa-db-ja.com

manページのネストされたリスト

後でいくつかのフラグを受け取るコマンドラインパラメーターがあります。これは、manページのパラメーターリスト内のリストとして使用したいと思います。

現在、私は単にFlag - Descriptionmanページ )の行を作成していますが、これは次の理由で理想的ではありません。

  • 折り返された行をインデントしません。手動でインデントすることはできますが、コンソールの幅を設定する必要があります。これはやりたくないことです。
  • 次の行に移動するには、二重改行に依存する必要があります。.TPのようなものが必要です。
6
Mat
  • リストは.RSで始まり、.REで終わります。
  • .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

生産性を上げるために、manページをよりわかりやすい形式で記述してから変換することをお勧めします。いくつかの適切なツールが スクリプトのマニュアルページを作成できますか? に列挙されています。

8
manatwork