手册页部分 1：用户命令

radadrdoc (1)

名称

radadrdoc - 文档生成器

用法概要

/usr/bin/radadrdoc [-h] -o {adr, docbook, docbook-man, man, html,
 rmdoc, spec-odoc}
 adr

描述

radadrdoc 命令是 ADR IDL 文档处理工具。它主要用于生成 ADR 规范文档。

所有调用都会根据 ADR 方案来验证给定的 adr。

选项

支持以下选项：

–o format

在 adr 中按照给定的格式生成接口定义文档。使用 summary 和 doc 元素来修饰接口定义的各个部分，从而可以改善文档。支持下列格式：

adr

扩展了 ADR IDL 格式以用于文档处理。

docbook

标准 DocBook 格式（文章），docbook-html 格式的前身。

docbook-man

DocBook 格式（man 格式的前身）的手册页内容。

html

从 DocBook 文章格式转换生成的 HTML 内容。

man

[nt]roff 格式的手册页。

rmdoc

删除 summary 和 doc 元素的 adr。

spec-odoc

odoctool 的 bundlespec 文件。有关更多信息，请参见 odoctool(1) 手册页。

–h，–-help

显示帮助消息并退出。

–o {adr, docbook, docbook-man, man, html, rmdoc, spec-odoc}

–-output-format {adr, docbook, docbook-man, man, html, rmdoc, spec-odoc}

输出格式。

操作数

支持下列操作数：

adr

必须为其生成类型和接口定义的 API 规范的路径。

示例

示例 1 生成手册页

以下命令生成一个手册页，用于介绍 myapi.adr 中定义的 API 的 C 客户机文档：

$ radadrdoc -o man myapi.adr > myapi-1.3rad

文件

/usr/share/lib/xml/rng/radadr.rng.1

核心 ADR RelaxNG 方案定义。

/usr/share/lib/xml/rng/radadr-doc.rng.1

文档元素的 ADR RelaxNG 方案定义。

属性

有关下列属性的说明，请参见 attributes(7)：

属性类型 属性值 可用性 system/management/rad/radadrgen 接口稳定性 Private（专用）

另请参见

attributes(7)、rad(8)、 odoctool(1)