マニュアルページで可変長オプションを文書化する正しい方法

マニュアルページで可変長オプションを文書化する正しい方法

時々、次の使用メッセージが表示されます。

some_utility [arg [arg [...]]]

または

some_utility [arg[, arg[...]]]

これは、複数の同じパラメータを渡すことができることを示しています。

私も似たようです。

some_utility [args]

または

some_utility [arg][, arg][...]

これを行う標準的な方法はありますか?

答え1

いいえ、そうではありません。本物しかし、ほとんどの場合、かなり一貫性があります。ほとんどのマニュアルには、オプションのパラメータが角括弧()で示されており、必須パラメータが[foo]山括弧で示されているか、括弧がまったく表示されていません(、、<bar>後者bazは通常下線付き)。

また、ほとんどの場合、引数の数が可変である場合は、一種のリスト(あなたが言及したように、[quux ...]または[quux[, quux[...]]]...)があります。同様に、[quuz]ほとんどの場合、正確に表現されます。一つ議論。まれに、[quuz]「1つ以上の引数」を意味することもありますが、ほとんどのマニュアルはリスト形式の省略記号に従います。

これは準標準ですが、絶対に信頼できません。しかし、私の経験によると、95%は問題ではありません。

要点は、「大企業」だけでなく、個人が作成した有用であると証明されたソフトウェアまで、さまざまな色のソフトウェアベンダーが数百社あることです。それらのすべては(希望的に)個人的な方法でマンページを作成します。欠陥;)

関連情報