Ronn はMarkdownテキストからmanページをビルドし、標準のUNIX roff形式ファイルや独立したHTMLドキュメントを生成します。
基本のManドキュメント構造 (tool.1.ronn)
tool(1) -- ツールの簡潔な説明
======================================
## SYNOPSIS
`tool` [<options>] <files>...
## DESCRIPTION
**tool** はファイルを処理し、結果を標準出力に出力します。
## OPTIONS
* `-v`, `--verbose`:
詳細なログ出力を有効化。
* `-o` <file>, `--output`=<file>:
出力先ファイルを指定。
* `-h`, `--help`:
ヘルプ画面を表示。
## EXAMPLES
すべてのマークダウンファイルに対してツールを実行:
$ tool -v *.md -o output.log
## SEE ALSO
man(1), ronn(7)
コンパイルコマンド (Compilation Commands)
# 標準のUNIX roff manページに変換 (tool.1)
ronn --roff tool.1.ronn
# HTMLフォーマットに変換 (tool.1.html)
ronn --html tool.1.ronn
# ファイルを作成せずターミナルで直接プレビュー表示
ronn --man tool.1.ronn