1. ronn-fomart(7)
3. ronn-fomart(7)

NAME

ronn-fomart - 基于markdown的手册编写格式

描述

ronn命令可以将注释文本转化成man手册页，ronn-format包含markdown格式 的所有特性，同还引入了一些其他在man手册中使用的约定和标记。注意， ronn-format并不包含所有的roff格式特性。

手册标题

手册标题由名称、类别和一行描述性文本组成，文件必须以Setext中最高阶标题的 形式开始。如下范例：

ls(1) -- list directory contents
================================

章节标题

章节标题可以用markdown语法中的二级类atx形式或者二阶类Setext形式。如下 范例：

##HEADING TEXT
或者
HEADING TEXT
------------

行内标记

通常man手册使用的加粗、斜体和下划线，ronn使用如下语法来完成。

`反斜杠`

兼容Markdown,反斜杠可以用来包裹代码、标志、命令符和其他 类似物，在man中表现为粗体，HTML代码为<code>。

**双星**

兼容Markdown,同样表现为粗体，与反斜杠不同，其内部使 用的标志语言依然会被识别，HTML代码为<strong>。

<尖括号>

不兼容Markdown,该自定义标志内部文本表现为文本下添加了下划 线，在网页中显为斜体，HTML代码为<var/>。

_下划线_

兼容Markdown,强调，可以用来表示选项参数，表现为文本下添加 下划线，HTML代码为<em>。

下面例子使用ronn语法来表示Grep(1)的描述行：

`Grep` searches the named input <FILE> (or standard input if
no files are named, or the file name `-` is given) for lines
containing a match to the given <PATTERN>. By default, `grep`
prints the matching lines.

列表

在ronn中定义列表的方式同Markdown一致，但是要求列表的第一行以分号:结 束，此后可以包含段落，代码和嵌套列表等。下面以BSD test的DESCRIPTION为 例。

* `-b` <file>:
True if <file> exists and is a block special file.

* `-c` <file>:
True if _file_ exists and is a character special file.

* `-d` <file>:
True if file exists and is a directory.

链接

ronn支持所有markdown的链接特点。

## SECTION 1

See the following section.

## SECTION 2

See [SECTION 1][] or [to put it another way][SECTION 1].

更多SEE ALSO

ronn(1), markdown(7), roff(7)

2. February 2015
3. ronn-fomart(7)