:option: / コマンドラインオプション

:option:

実行ファイルのコマンドラインオプションを記述する。

前に付くハイフンも含める必要がある。

option ディレクティブ で定義されていれば、リンクを作成する。

クロスリファレンスを作成する。オブジェクト参照はしない。

sample

source:

command:

  :option:`sample1 -r`

  :program:`sample1` :option:`-v <sample1 -v>` :option:`-r <sample1 -r>`

  :option:`sample1 --remove`

  :option:`sample1 --help`

output:

command:

sample1 -r

sample1 -v -r

sample1 --remove

sample1 --help