docやブログに書くコマンド例の構文や表記の規則 - tweeeetyのぶろぐ的めも

docやブログに書くコマンド例の構文や表記の規則 - tweeeetyのぶろぐ的めも

はじめに docやブログやwikiを書くとき、 こんな感じでコマンド例を載せることは多いと思います。 hoge ...概要を表示 はじめに docやブログやwikiを書くとき、 こんな感じでコマンド例を載せることは多いと思います。 hoge {fuga|piyo} [-f <filename>] ※ 適当です そんなとき、 毎回{}や[]や<>辺りを迷うので、これはちゃんと自分の中でまとめられてないからだな、と。 そんな自分のためのメモです。 規則 構文規則 説明 例 [ ] 大括弧 [ ](大括弧)は、任意のオプションであることを示します。 大括弧で囲まれていないものの指定は必須です。 [-h host_location] ※ なくても良い { } 中括弧 { }(中括弧)は、相互に排他的な一連のオプションを示します。その中のどれか1つを指定する必要があります。 {-i IP_address | -n host_name} ※ どちらか必須 | 垂直バー |(垂直バー)は、相互に排他的なオプションを区切ります。 {