update-yorickdoc - 云端在线

程序：

您的姓名

update-yorickdoc - 为 Yorick 构建 HTML 文档

概要

更新yorickdoc [--conf=文件] [- 汽车[--自动现在[--来自=目录] [--到=目录]
[--外部参照目录=目录] [--src-目录=目录] [--模板=文件]

商品描述

update-yorickdoc 是 htmldoc.i 的包装器，是一个用于提取 DOCUMENT 的 Yorick 脚本
Yorick 源文件中的注释并将它们转换为一组 HTML 文件。
update-yorickdoc 合并来自“源目录”的文件（默认：/usr/share/yorick-doc，
命令行选项：--src-dir），删除目标目录（默认：
/usr/share/doc/yorick-doc/html_xref)，如果安装了 Yorick，则调用“yorick -batch
htmldoc.i" 为所有当前安装的函数编译 HTML 文档（或者
从主 Yorick 包或从附加包）。

update-yorickdoc 旨在在 Yorick 包被调用时自动调用
安装或删除。 可以通过设置“ENABLE_AUTO”来阻止自动更新
到 0 在 /etc/yorick-doc. 也可以手动使用 update-yorickdoc 创建
来自自定义目录的文档（例如用户自己的 〜/约里克/ 目录）或
自定义地点，例如。

update-yorickdoc 有一组默认参数可以使用。 这些参数是
按时间顺序被内容 /etc/yorick-doc、$HOME/.yorick-doc 和
命令行。

此脚本需要一些文件才能运行。 默认文件在
默认源目录，附加包应在
一样的地方。 看 FILES 下面以及/usr/share/doc/yorick-dev/yorick-policy.gz。

配置

- 汽车 | -a
由于 dpkg 中触发器的出现，此标志已被弃用。 在 dpkg 的系统上
支持触发器，-a 将 update-yorickdoc 变为无操作。 在旧系统上，它
行为类似于下面的 -A。

--自动现在 | -A
此标志仅用于 yorick-doc 包的 postinst 脚本，
应该在每次 yorick 附加包被触发时触发
安装、升级或删除。 可以将 update-yorickdoc 变成 no-op
当通过在 /etc/yorick-doc 中将 ENABLE_AUTO 设置为 0 来设置此标志时。

--conf=文件
从此文件中读取配置。 该文件被解析为在
命令行，覆盖之前的选项。

--来自=目录 1:目录 2...
以冒号分隔的目录列表，用于扫描 Yorick 文件。 默认：
/usr/share/yorick/i:/usr/share/yorick/i0.

- 清除 | -p
只删除 /usr/share/doc/yorick-doc/html_xref （或使用 --to 和
--xref-dir 或 /etc/yorick-doc 中的等效变量），不要重建
之后的文档。

- 安静的 | -q
保持安静，只简要说明 update-yorickdoc 的作用。 这是内置的
默认但可能已在配置文件中被覆盖。

--src-目录=目录
构建时包含 .packinfo、.keywords 和 .aliases 文件的目录
文档。 这三种类型的文件中的每一种都将连接在
字典顺序并使用 --packinfo、--keywords 和
--aliases 选项（参见 htmldoc.i）。 默认值：/usr/share/yorick-doc。

--模板=文件
htmldoc.i 的模板文件。 正确的格式是详细的htmldoc.i。 默认：
/usr/share/yorick-doc/template.html。

--到=目录
要更新的 Yorick HTML 层次结构的顶级目录。 这是上一层
将被删除和/或（重新）构建的目录。 默认为
/usr/share/doc/yorick-doc。

--详细 | -v
冗长，输出大量调试信息。 内置默认值是
安静，只是简单地说一下 update-yorickdoc 做了什么。

--外部参照目录=字
用于编译文档的“TO”目录的子目录。 肯定
文档中的超链接将使用此值。 这不应该设置为
您重视其内容的目录，因为该目录将首先被删除。 默认：
html_外部参照。

使用 onworks.net 服务在线使用 update-yorickdoc