コマンドの書式を知りたいときは、ネットで検索すればそのコマンドの使い方やオプションなどの説明ページはすぐに見つかります。
しかし、コマンドの利用方法を説明するために利用される構文フォーマットというものがあり、この構文フォーマットがわからないと、説明サイトを見てもヘルプを見てもコマンドの書き方が具体的にわからないというケースが多いので構文フォーマットをまとめてみました。
構文フォーマットの特殊文字一覧
基本的に書式を説明する際は特殊文字を利用します。
※わかりやすく解説するため、「cmdxxx」という架空のコマンドを利用して説明します。
斜体
斜体で記載されている部分は適切な値を入力する必要のある部分を意味します。日本語または英語で書かれているそのままの意味の値を入力します。
【例】cmdxxxファイル名
この例ではcmdxxxというコマンドを実行するファイル名を入力します。
[ ]
[ ] で囲まれたオプションは任意項目です。この括弧で囲まれているオプションはあっても無くても構いません。
【例】cmdxxx [-f] ファイル名
この場合の -f オプションはあっても無くても良いという意味です。
< >
必須項目です。< >で囲まれた部分の入力は必須であることを示しますので適切な値を指定してください。
【例】cmdxxx -d <ディレクトリ名>
この場合は -d オプションの後のディレクトリ名が必須ということになります。
{ }
{ } は必須選択項目です。{ } で囲まれた複数のオプションや入力項目がある場合は最低でも必ずどれか1つを指定または入力する必要があります。後述の区切り文字 | と一緒に利用されます。
【例】cmdxxx {-a|-f|-r} ファイル名
この場合は -a -f -r という3つのオプションのうちどれか1つは必ず指定する必要があるという意味です。
|
| で区切られたオプションは互いに排他的という意味です。ORと同義です。区切り文字 | で分けられたオプションはどれか一つのみが使用可能で複数のオプションを利用することは出来ません。
【例】※上記 { } の例を参考にしてください。
…
複数の値を指定することが出来るという意味です。
【例】cmdxxx ファイル名...
この場合はファイル名を複数指定してもOKという意味です。
具体的には cmdxxx aaa.txt bbb.txt ccc.txt というような書式が可能という事です。
\
コマンド行がEnterキーで折り返していることを示します。複数行となっていても行の末尾に \ がある場合はそのコマンドが継続しているということになります。
【例】cmdxxx [-a|-b] ファイル名 \
{-d ディレクトリ名|-dg ディレクトリ名}
↑上記の例は複数行で書かれていますが、
cmdxxx [-a|-b] ファイル名 {-d ディレクトリ名|-dg ディレクトリ名}
という一行のコマンドと同義です。
まとめ
大抵は上記で解説した特殊文字が複数同時に使われます。一見するとカオスに見えますが特殊文字の意味とルールを知れば単純です。
最近はこれらの構文フォーマットを利用しないケースも増えてきましたが、念のために覚えておくとコマンドの利用方法が簡単に理解できてとても便利なので頭に入れておきましょう。
