3.1 書式について

全コマンドに共通して示される書式の意味について解説する。 全てのコマンドリファレンスにおいて、書式は以下の例のように示される。

コマンド名に続いて、そのコマンドに指定可能なパラメータおよびオプションが列挙されている。 多くのコマンドで共通するi=,-nfnなどのパラメータやオプションについては、別の節にてまとめて記述されており、 その節へのリンクが張られている。 そして、各パラメータの説明が、書式の下に記述される。

[f=]のように四角括弧で囲われたパラメータは省略可能であることを意味する。 一方で、k=のように四角括弧で囲われていないパラメータは必須であることを意味する。 また[to=|size=]のように縦棒で区切られたパラメータは、 いずれか一つのパラメータしか指定できないことを意味し、括弧で囲われていることで省略することも可能という意味になる (例えばmbestコマンド)。 一方でm=|i=のように四角括弧で囲われていなければ、必ずいずれかのパラメータは指定しなければならない、 すなわち選択必須のパラメータであることを意味する(例えば、上記のmjoinコマンド)。

また、あるオプションを指定していたときのみ必須となるパラメータなど、より条件が複雑なパラメータもあるが、 それらは、各パラメータの説明欄にて解説している。