オプション、引数の意味

SYNOPSIS項目では、コマンドの形式、つまりコマンドに適用できるオプション、引数などが列挙されています。オプションとは「コマンドの振舞い、機能を変えるような指示」を指し、引数とは「コマンドが処理するべき対象(など)」を指します [1]

SYNOPSIS
     cal [-mjy13] [ [month] year]

ここでの表記にはルールがあります。上の cal の例で説明します。

  1. [ ] に囲まれた部分は「なくてもいい」つまり省略可能だという事を意味しています。
    [ ] を書きなさい、ということではありませんので念のため。
  2. こういう場面での「- (ハイフン)」は一般にこの部分がオプションであるという目印ですが、特に上記の例のように、すぐ後に多くのオプション文字「 mjy13 」がくくられていた場合は、その中のどれでもピックアップして同時に与えていいよ、という意味です。
    -m」や「-3」と与えるだけでなく、「-m -3」と続けて書いたり、「-m3」と書いたりすることができます。
  3. [ [ month ] year ] と二重に [ [ ] ] で括られていた場合、より深い [ ] のペアから省略可能です。
    上の例では「12 2003」のように month, year を両方とも与える、「2003」 のように year だけを与える、何も与えない、という書き方ができます。逆に「12」と month だけ指定する、と言うようなことはできません。
    (その場合は month が略されたと解釈されて西暦 12 年のカレンダーが表示されるでしょう。)
  4. また、例にはありませんが、「...」という記述があれば、その直前のものを繰り返して書いてもいいよという意味です。
  5. コマンドにオプションや引数をつけてタイプする場合、man に表示された順番に注意する必要がある場合があります。

このルールによれば、たとえば以下の可能性があります。

cal -m月曜を週の最初に表示します
cal -3前月、今月、来月の三カ月分を表示します
cal -m -3月曜をはじめにして、前月、今月、来月の三カ月分を表示します
cal -m3同上
cal 12 19991999 年 12 月のカレンダーを表示します
cal 19991999 年のカレンダーを表示します
cal -m3 12 1999月曜を前に、1999 年 12 月の前後を含めて三カ月ぶんのカレンダーを表示します

man コマンドにおけるオプションの与え方の表記のクセについて一つだけ、以下に紹介しておきます。

オプションが振舞いや機能を、引数が処理対象の指示を行なっていることがわかるでしょう。



Yutaka Yasuda (yasuda@bakkers.gr.jp)