man ページの文法と書式の読み方

「man ページのセクション番号の意味」は 2005-08-09 に要点を書いた。しかし、コマンドやオプションの文法についてはなんとなくわかったつもりになってたのでメモ。これらは書式 (SYNOPSIS) と呼ぶ。

Software Design 2005年9月号63ページ

[] は、省略可能なオプション (とその引数)
{} は省略不可能なオプションで、中に選択肢 (次行) が示される
| は選択肢で、列挙されたいずれかを排他的に選択する
... は繰り返し

上記がわかれば、以下のような書式の意味もわかる。

passwd [-f|-s] [name]

-f か -s を指定できる。name 指定できる。オプションはすべて省略可能なので、passwd だけでも OK。この場合は自分自身のパスワードを変更するモードだね。

passwd [-g] [-r|-R] group

-g を指定できる。-r か -R を指定できる。 group は 必須。

passwd [-x max] [-n min] [-w warn] [-i inact] login

-x とその引数を指定できる。 -n とその引数を指定できる。-w とその引数を指定できる。-i とその引数を指定できる。login は必須。

passwd {-l|-u|-d|-S|-e} login

-l -u -d -S -e のいずれかが必須。login は必須。