必須パラメーターを持つ/ optionsが必要なツールの仕様を作成しています-f。たとえば、次は有効な呼び出しです。--fooBAR
tool -f BAR
tool --foo BAR
マンページまたは他の正式に定義された呼び出しセクションでこの構文をどのように指定できますか？
これは、次のオプションが必要ないことを意味し、これは私の意図ではありません。
tool [-f BAR | --foo BAR]
しかし、単にブラケットを省略することは意味がありません。パイプが実際のシェルパイプに誤認される可能性があるためです。
POSIX長い選択ではありません、GNUリファレンスも見つかりません。
ベストアンサー1
tool -f BAR | --foo BARtool -f BAR私はそれを「コマンドでパイプ出力」として解釈するのが一般的ではないと思います--foo BAR。だから私は単に
tool -f BAR | --foo BAR
特に、呼び出しがより複雑な場合は、より明確にするために追加のマークアップを使用する可能性があります。オプションのパラメータとは異なり、[]これらのいずれも次のように一般的に理解されていません。強要された主張、例えば：
tool {-f BAR | --foo BAR}
または
tool <-f BAR | --foo BAR>
そしてさらに
tool (-f BAR | --foo BAR)
呼び出し仕様を誤って読者がいないことを確認するには、コピーします。
tool -f BAR
tool --foo BAR
この複数のアプローチを使用する多くのマニュアルページとプログラムのヘルプを見ることができますが、通常は同等の呼び出し以外の呼び出しに使用されます。