はじめに
docやブログやwikiを書くとき、
こんな感じでコマンド例を載せることは多いと思います。
hoge {fuga|piyo} [-f <filename>]
※ 適当です
そんなとき、
毎回{}や[]や<>辺りを迷うので、これはちゃんと自分の中でまとめられてないからだな、と。
そんな自分のためのメモです。
規則
| 構文規則 | 説明 | 例 |
|---|---|---|
| [ ] 大括弧 |
[ ](大括弧)は、任意のオプションであることを示します。大括弧で囲まれていないものの指定は必須です。 |
[-h host_location] ※ なくても良い |
| { } 中括弧 |
{ }(中括弧)は、相互に排他的な一連のオプションを示します。その中のどれか1つを指定する必要があります。 |
{-i IP_address | -n host_name} ※ どちらか必須 |
| | 垂直バー |
|(垂直バー)は、相互に排他的なオプションを区切ります。 |
{-i IP_address | -n host_name} ※ どちらか必須 |
| ... 省略符号 |
...(省略符号)は、直前のオプションが異なる値で複数回繰り返し指定可能であることを示します。大括弧の内側でも外側でも使用できます。 |
[-x files]... ※ -x file1 -x file2 -x file3 [-x file...] ※ -x file1 file2 file3 |
| < > 山かっこ |
< >(山かっこ) は変数を示します。この値は必ず指定する必要があります。 |
-f <file_name> |
| \ バックスラッシュ |
コマンド業の継続を表す記号です | hoge fuga \ -a piyo\ -b poko |
| 太字 | 正確に入力する必要があるリテラル情報を示します | nids-c config_filename |
| イタリック | イタリック・テキストは変数で、それが表現するものと置換する必要があります | file_name |
| " " 二重引用符 |
オプションを囲む""(二重引用符)は、1つのオプションとして解釈されることを指定します |
-L "-p 9495" |
| ' ' 二重引用符 |
オプションを囲む''(単一引用符)は、1つのオプションとして解釈されることを指定します |
ls 'part 1' |
※ 参考サイトから説明はお借りしている部分があります
参考サイト
おわり
コマンドラインのコンテキストによっても若干違いはあると思いますが、だいぶ自分の中でもすっきりした気がします＼(＾o＾)／
