ちょっとしたメモ
コマンドの説明の例.
1 2 3 4 5 |
|
括弧が「[]」と「<>」で異なっている.
今までイマイチ気にしていなかったので,少し調べてみる.
調べればごろごろ出てくる.
コマンド構文規則 - IBM
4. コマンド構文
コマンドの記載形式
コマンド ライン構文の文字 - CA ARCserve® Backup for …
表記規則 - 日本オラクル
ここら辺を見れば意味はわかるんだけど,何が元になってるのか気になってもうちょっとうろうろしてみた.すると以下のような記載を発見.
ってかこれって統一文法みたいなのがあるのか?UNIXのmanコマンド表記がベースになってるのかな?
コマンド表記法 - 俺の基地
UNIXのman
コマンドを知らなかったので調べてみる.
基本的なUNIXコマンド
UNIXコマンド - man (Linux/FreeBSD/Solaris) - k-tanaka.net
manページ - Wikipedia
man
コマンドは,UNIXコマンドのマニュアルを表示するコマンドのようだ.その前身ともいえる UNIX Programmer's Manual は1971年に出版され,その後オンラインのmanページが1971年に執筆された.そのレイアウトは以下のような構成になっている.
- NAME(名前)
- SYNOPSIS(書式)
- DESCRIPTION(説明)
- EXAMPLES(使用例)
- SEE ALSO(関連項目)
このうち,SYNOPSISに構文規則を用いた表記法が用いられているので,これが元なのではないかということ.実際にこれが元かはわからないけど,とりあえず無駄知識を増やすことができたので満足した.暇があったらまた調べてみよう.
とりあえず,代表的なものをまとめておく.
表記法 | 概要 | 例 |
---|---|---|
[] | なくてもよい | hoge [-h]:-h はなくてもよい |
{}, <> | 必須 | hoge <filename>:filename は必ず記載 |
斜体 | 変数 | hoge <filename>:filename は変数.適切な値を記述する |
| | エレメントの選択 | hote [-a|-b]:-a か-b を選択 |
… | 繰り返し | hoge <file>… :hoge file1 file2 file3 と使用できる |