a2x - 云端在线

程序：

您的姓名

a2x - AsciiDoc 的工具链管理器（将 Asciidoc 文本文件转换为其他文件
格式）

概要

a2x [配置] 源文件

商品描述

翻译 AsciiDoc 文本文件的 DocBook 工具链管理器 源文件 到PDF，
EPUB、DVI、PS、LaTeX、XHTML（单页或分块）、手册页、HTML 帮助或纯文本
格式使用 阿斯西多克(1) 和其他应用程序（参见要求部分）。 源文件 能够
也可以是扩展名为 .xml 的 DocBook 文件。

配置

-一种， - 属性=属性
在 阿斯西多克(1) 属性值（快捷方式为 --asciidoc-opts=“-一种 属性” 选项）。
可以多次指定此选项。

--asciidoc-opts=ASCIIDOC_OPTS 选项
额外 阿斯西多克(1) 选项。 可以多次指定此选项。

--conf-文件=配置文件
加载配置文件。 请参阅配置文件部分。

-D, --目的地目录=目的地_目录
输出目录。 默认为 源文件 目录。 此选项仅适用于
基于 HTML 的输出格式 (分块, EPUB, 帮助, 的xhtml).

-d, --文档类型=DOCTYPE
DocBook 文档类型： 刊文, 联机帮助页 or 书. 默认文档类型为 刊文
除非格式是 联机帮助页 （在这种情况下，它默认为 联机帮助页).

-b, --后端=后端
后端 是已安装的后端插件的名称。 指定此选项时 a2x
尝试加载文件名 a2x-后端.py 来自 后端 插件目录 然后
转换 源文件 到 后端 使用全局函数格式化输出文件
定义于 a2x-后端.py 被称为 到_BACKEND.

-F， - 格式=FORMAT
输出格式： 分块, 文档书, DVI, EPUB, 帮助, 联机帮助页, PDF格式 （默认）， ps,
TEX, 文本, 的xhtml. AsciiDoc a2x 格式 属性值设置为 FORMAT.

-H， - 帮帮我
将命令行语法和程序选项打印到标准输出。

--图标
在输出文档中使用警告或导航图标图像。 默认行为是
使用文本代替图标。

--icons-目录=PATH
包含警告和导航图标的路径（相对于输出文件）。 默认值
到图像/图标。 这 --图标 如果使用此选项，则选项是隐式的。

-k, --保持工件
不要删除临时构建文件。

--山猫
使用 猞猁(1) 生成文本格式的输出。 默认行为是使用 w3m(1).

-L, --no-xmllint
不要检查 asciidoc 输出 xmllint(1).

---epubcheck
检查 EPUB 输出 电子书检查(1).

-n, --试运行
不要做任何事情，只是打印本来应该做的事情。

-r, --资源=资源_规格
指定资源。 可以多次指定此选项。 见 资源
部分了解更多详情。

-米， --资源清单=文件
文件 包含一个列表资源（每行一个）。 显现 文件 条目被格式化
就像 --资源 选项参数。 环境变量和波浪号主页
目录是允许的。

--样式表=样式表
一个或多个用于设置样式的 CSS 样式表文件名的空格分隔列表
DocBook XSL 样式表生成的 HTML 输出。 默认为 docbook-xsl.css。 该
样式表按列表顺序处理。 样式表必须位于有效的
资源文件位置。 适用于 HTML 格式： 的xhtml, EPUB, 分块, 帮助
格式。

-v， --详细
将操作详细信息打印到 stderr。 一秒 -v option 将详细选项应用于
工具链命令。

- 版
将程序版本打印到标准输出。

--xsltproc-选项=XSLTPROC_OPTS
额外 xslt过程(1) 选项。 可以多次指定此选项。

--xsl-文件=XSL_文件
使用自定义 XSL 样式表覆盖内置 XSL 样式表 XSL_文件.

--fop
使用 FOP 生成 PDF。 默认行为是使用 dblatex(1)。 该 --fop 选项
如果使用此选项，则是隐式的。

--fop-选项=FOP_OPTS
额外 纨裤子弟(1) 选项。 如果指定了此选项，则 FOP 用于生成 PDF。
可以多次指定此选项。

--dblatex-opts=DBLATEX_OPTS 选项
额外 dblatex(1) 选项。 可以多次指定此选项。

--后端选项=后端选项
由指定的后端插件的选项 --后端 选项。 这个选项可能是
指定不止一次。

也可以在 AsciiDoc 源文件中设置选项。 如果 源文件 包含评论
行开头 // a2x： 那么该行的其余部分将被视为 a2x
命令行选项。 例如：

// a2x 默认选项。
// a2x: -dbook --epubcheck
// 抑制 dblatex 输出中的修订历史记录。
// a2x: --dblatex-opts "-P latex.output.revhistory=0"

· 跨越多个这样的注释行的选项将被连接起来。

· 前导之间可以出现零个或多个空白字符 // 和 a2x：.

· 命令行选项优先于源文件中设置的选项。

OUTPUT FILES

输出文件被写入指定的目录 --目的地目录 选项。 如果不
--目的地目录 选项设置输出文件写入 源文件 目录。

输出文件具有相同的名称 源文件 但有一个合适的文件名
扩展名：.html 用于 的xhtml; .epub 为 EPUB; .hhp 用于 帮助; .pdf 为 PDF格式; .text 用于
文本, .xml 为 文档书. 按照惯例手册页没有 .man 扩展名（手册页部分
仅数字）。 分块 HTML 目录名称具有 .chunked 扩展名； 分块 HTML 帮助
目录名称具有 .htmlhelp 扩展名。

同名的现有文件将被覆盖。

除了生成 HTML 文件之外， 的xhtml, EPUB, 分块 和 帮助 格式确保
资源文件被复制到其正确的目标目录位置。

资源

资源是基于 HTML 的输出所需的文件（通常是 CSS 和图像）
(的xhtml, EPUB, 分块, 帮助 格式）。 a2x 扫描生成的 HTML 文件并构建一个
所需的 CSS 和图像文件的列表。 可以指定额外的资源文件
明确使用 --资源 选项。

a2x 按以下顺序在以下位置搜索资源文件：

1. 源文件 目录。

2. 指定的资源目录 --资源 选项（递归搜索）。

3. 指定的资源目录 --资源清单 选项（递归搜索
按照它们在清单文件中出现的顺序）。

4. 库存图片和样式表目录 阿斯西多克(1) 配置文件
目录（递归搜索）。

5. 目标目录。

找到资源文件后，会将其复制到正确的相对目标目录。
自动创建缺少的目标子目录。

有两种不同的机制来指定额外的资源：

1. 一个资源目录，将递归搜索丢失的资源文件。

2. 将复制到输出目标目录的资源文件。

资源指定为 --资源 选项值可以是以下之一
格式：


[= ]
. =

地点：


指定目录（绝对或相对于 源文件) 被搜索
递归丢失的资源文件。 为了消除歧义姓名
应该以目录分隔符结尾。


指定资源文件（绝对或相对于 源文件) 这将是
复制到. 如果没有指定那么它是
与.


指定复制的源文件的目的地。 这路径是
相对于目标目录（不允许使用绝对路径）。 那个地点
目标目录取决于输出 FORMAT （见 OUTPUT FILES
详情部分）：

分块，htmlhelp
分块的输出目录。

EPUB
存档的 OEBPS 目录。

的xhtml
输出 目的地_目录.

. =
将资源添加到 EPUB 文件时，mimetype 是从
file> 扩展名，如果不能猜出 mimetype，则会发生错误。 这
. = 资源语法可用于显式设置 mimetypes。 是
文件扩展名， 是对应的 MIME 类型。

资源选项示例：

--资源../图像/
--资源文档/README.txt=README.txt
--资源 〜/图像/老虎.png=图像/老虎.png
--resource .ttf=应用程序/x-font-ttf

示例

a2x -f pdf 文档/source-highlight-filter.txt
生成 doc/source-highlight-filter.pdf 文件。

a2x -f xhtml -D ../doc --icons -r ../images/team.txt
创建 HTML 文件 ../doc/team.html，使用警告图标并递归搜索
../images/ 目录以查找任何丢失的资源。

a2x -f 联机帮助页 doc/asciidoc.1.txt
生成 doc/asciidoc.1 联机帮助页。

要求

a2x 使用以下程序：

· 阿西多克: http://asciidoc.org/

· xslt过程：（除文本外的所有格式）： http://xmlsoft.org/XSLT/

· DocBook的 XSL 样式表 （除文本外的所有格式）：
http://docbook.sourceforge.net/projects/xsl/

· dblatex （pdf、dvi、ps、tex 格式）： http://dblatex.sourceforge.net/

· FOP 扩展名 （pdf 格式 — 替代 PDF 文件生成器）： http://xmlgraphics.apache.org/fop/

· w3m （文本格式）： http://w3m.sourceforge.net/index.en.html

· 山猫 （文本格式——替代文本文件生成器）： http://lynx.isc.org/

· 电子书检查 （epub 格式 — EPUB 文件验证器）： http://code.google.com/p/epubcheck/

另请参阅最新的 README 文件。

大会 FILES

配置文件包含覆盖全局的可执行 Python 代码
a2x.py 中的配置参数。 可选的配置文件加载在
以下顺序：

1. a2x.conf 来自包含 a2x.py 可执行文件。

2. 来自 AsciiDoc 全局配置目录的 a2x.conf。 如果我们是，请跳过这一步
执行本地安装的（非系统范围的）副本。

3. 来自 AsciiDoc $HOME/.asciidoc 配置目录的 a2x.conf。

4. 配置文件 在指定 --conf-文件 选项。

以下是默认配置文件选项值：

# 可选的环境变量字典传递给
# 执行程序。 如果设置为 None 现有
# 使用环境。
ENV = 无

# 外部可执行文件。
ASCIIDOC = 'asciidoc'
XSLTPROC = 'xsltproc'
DBLATEX = 'dblatex' # pdf 生成。
FOP = 'fop' # pdf 生成（--fop 选项）。
W3M = 'w3m' # 文本生成。
LYNX = 'lynx' # 文本生成（如果没有 w3m）。
XMLLINT = 'xmllint' # 设置为 '' 以禁用。
EPUBCHECK = 'epubcheck' # 设置为 '' 以禁用。
# 外部可执行默认选项。
ASCIIDOC_OPTS = ''
DBLATEX_OPTS = ''
FOP_OPTS = ''
XSLTPROC_OPTS = ''

使用 onworks.net 服务在线使用 a2x