コマンドの概要を記述するための標準はありますか?


14

エンドユーザーに対するコマンドの使用法を説明する概要を書く方法について、誰もが独自のアイデアを持っているように思えます。

たとえば、これは次の形式ですman grep

grep [OPTIONS] PATTERN [FILE...]
grep [OPTIONS] [-e PATTERN | -f FILE] [FILE...]

現在、これには他のマンページに表示される構文があります。 []はオプションとして認識され...、同じ入力の複数として意味をなします。

しかし、人々はORを使用する|/、ORを使用します[]。または、どこに[OPTIONS]行くかについての指示を与えません。

私は自分が書いたものの標準に従うことを望みますが、私が見ているウェブサイトはすべて違うことを教えてくれます。

概要を記述する実際の標準的な方法はありますか、それとも、慣習は人々が長い間やってきたことですか?


1つを選んでそれを使い続けます。
ケビン14

何らかの理由で、私はそれが役立つとは思わない。すべての人が独自の標準を持ち、それについて何も実行されません。
トーミスト14


はい、これはまさに私が探していたものです。ありがとうございました。
トーミスト14

1
@MarkPlotnick-私はそれをAにして、OPがそれを受け入れられるようにします。それがあれば、それが標準です。illuminÉが参照したリンクを参照してください。
slm

回答:


8

これの古典的な標準は、POSIXのUtility Argument Syntaxからのものです(更新されたリンクについて@illuminÉに感謝します)。たとえば、manページで使用される構文について説明しています。

utility_name[-a][-b][-c option_argument]
    [-d|-e][-f[option_argument]][operand...]

古典的である-Wため、ベンダーによる使用が推奨されている単一文字オプションの使用を推奨しています。これが、複数文字オプションの対応方法です(たとえば、gcc Option Summaryを参照)。

GNUソフトウェアでは、で始まる複数文字オプションが導入されました--。これらのオプションを使用してマニュアルページをフォーマットするためのGNUのガイドラインは、help2manリファレンスにあります。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.