← 返回命令列表

Linux command

ronn 命令

文件

复制后可按需替换文件名、目录或参数。

常用示例

Convert to man page

ronn [file.ronn]

Convert to HTML

ronn --html [file.ronn]

Convert to both

ronn --roff --html [file.ronn]

Preview in browser

ronn --server [file.ronn]

Specify output directory

ronn --output-dir [man/] [file.ronn]

说明

Ronn converts Markdown-like text to Unix man pages and HTML. It uses an extended Markdown syntax for writing manual pages in a readable format.

参数

--roff
Generate roff (man page).
--html
Generate HTML.
--fragment
HTML fragment only.
--server, -S
Preview server.
--style _style_
HTML style.
--output-dir _dir_
Output directory.
--manual _name_
Manual name.
--organization _org_
Organization name for footer.
--date _YYYY-MM-DD_
Published date for footer.
-w
Show troff warnings on stderr.
-W
Disable troff warnings.

FAQ

What is the ronn command used for?

Ronn converts Markdown-like text to Unix man pages and HTML. It uses an extended Markdown syntax for writing manual pages in a readable format.

How do I run a basic ronn example?

Run `ronn [file.ronn]` in a terminal, then adjust file names, paths, flags, or remote targets for your system.

What does --roff do in ronn?

Generate roff (man page).