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

コマンドラインオプション(スイッチ)の説明を記述する。

.. option:: オプションの記述形式¶

コマンドラインオプションやスイッチの説明

Note

• :option: からのリンクが可能。
• :option: からリンクする場合は、対象となるコマンドを特定するために programディレクティブ を直前に記述する必要がある。
• 1行に複数のオプションを記述した場合、最初のオプションのみリンク対象となる。

.. program:: sample1

.. option:: -r, --remove

  -r の説明

.. option:: -v

  -v の説明

.. option:: --help

  --help の説明