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

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

時々、次のような使用情報が表示されます

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

または

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

これは、同じ引数を複数渡すことができることを示します。

私もこんなのを見たことがある

some_utility [args]

または

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

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

答え1

いいえ、違います本当にですが、ほとんどの場合、それはかなり一貫しています。ほとんどのマニュアルでは、オプションの引数は角括弧 ( [foo]) で、必須の引数は山括弧で、または括弧なしでリストされます ( <bar>baz、後者は下線が引かれることが多い)。

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

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

要するに、世の中には何百ものソフトウェア ベンダーがいて、大手だけでなく、個人が書いたソフトウェアもあって、役に立つことが証明されています。それらはすべて (願わくば) 独自の方法でマニュアル ページを書いています。ほとんどのベンダーは、一般的な慣習を順守するのに十分な知識を持っていますが、気にしないベンダーや、スタイルの好みなどに関して何らかの精神的な欠陥があるベンダーもいます。;)

関連情報