書き込みのいくつかの形式の大会を含め、コマンドラインパラメータを説明する際に、様々なシステム間の違いがあります。次の一般的なフォーマットを使用します:
コマンド<必須パラメータ1 |必須パラメータ2> [-option {1パラメーター必須|必須パラメータ2 | 3つの必須パラメータ}] [オプション...] {(デフォルトパラメータ)|パラメータ|}パラメータ
一般的に、いくつかのシンボルに使用されるコマンドの形式は以下の意味を有します:
山カッコは、<>:必要なパラメータが必要な実際のパラメータに置き換える必要があります
中括弧{}:必須パラメーターは、内部で使用される、ここで許可されたパラメータを含みます
角カッコ[]:選択する必要があるためのコマンドでオプションのパラメータ
括弧():{}のみに使用されるパラメータのデフォルト値を示し
縦線|:のみ使用することを選択することができることを意味し、「または」、相互に排他的な複数のパラメータを区切るために使用
省略記号...:任意の数のパラメータ
説明:
実際の交換必須パラメータに応じて選択するだけブレース必須パラメータ(または1)を記載するが、角括弧:へアングルブラケットとブレースとの間の差
例1:
コマンド構文:gitのヘルプ<名前>
実際の使用:gitのヘルプconfigまたはgitのヘルプのブランチまたは...(名前は実際のコンテンツに置き換えられます)
例2:
コマンド構文:gitの隠し場所{適用|ポップ}
実際の使用:gitの隠し場所が適用されますかgitのスタッシュポップ(唯一の必須のパラメータが適用されますかポップを選択)