Reference manual for FPDoc Document version 3.2.2

• 语言: 英语
• 格式: .pdf
• 来源: downloads.freepascal.org

摘要

本文档为FPDoc版本3.2.2的参考手册，主要描述了FPDoc的安装、编译和使用方法。安装过程包括从源代码编译和安装FPDoc以及相关工具如fpcmake和GNU gettext。文档生成支持多种格式，包括HTML、XML、CHM、RTF、LaTeX和Man页。同时，文档介绍了如何通过项目文件管理文档生成过程，并提供了关于本地化支持和语言文件安装的信息。

AI总结

以下是对文档内容的总结，语言简洁明了，重点突出核心观点和关键信息：

---

**《Reference manual for FPDoc Document version 3.2.2》总结**

### 1. 引言
- FPDoc 是 Free Pascal 的代码文档生成工具，支持多种输出格式，包括 HTML、LaTeX、RTF、CHM 和 UNIX 手册页（groff 格式）。
- 输出格式：
- `html`：普通 HTML，文件名长。

### 2. 编译和安装 FPDoc
- **编译需求**：
1. FPDoc 源码。
2. Free Pascal 编译器源码（用于扫描源文件）。
3. FCL 单位。
4. `fpcmake`（生成 Makefile）。
5. `rstconv` 和 GNU gettext（支持国际化）。
- **步骤**：
1. 解压源码，修改 `Makefile.fpc` 中的 `fpcdir` 至 Free Pascal 源码目录。
2. 运行 `fpcmake` 和 `make`。
- **安装**：
- 从源码安装：`make install`。
- 从二进制安装：将可执行文件放入 PATH 目录。
- **多语言支持**：语言文件需放置在 `/usr/local/share/locale/XX/LC_MESSAGES/` 或 `/usr/share/locale/XX/LC_MESSAGES/`。

### 3. 使用 FPDoc
- **命令行选项**：
- `--footer`：指定页脚文件（XHTML 格式）。
- `--footer-date`：生成包含当前日期的页脚，可自定义格式。
- `--format`：指定输出格式，支持 `html`、`xhtml`、`latex` 等。
- `--output`：指定输出文件名。
- `--update`：生成更新文件，仅创建缺失的文档节点。
- **输出格式**：
- `html`：生成 HTML 文件。
- `latex`：生成 LaTeX 文件，使用 `fpc.sty` 样式。
- `xhtml`：生成 XHTML 文件。
- `chm`：生成压缩的 HTML 帮助文件。
- `man`：生成 UNIX 手册页文件。

### 4. 项目文件
- **功能**：
- 解决命令行过长问题。
- 提供结构化的配置方式。
- **格式**：
- XML 文件，包含 `options` 和 `packages` 标签。
- 示例：

### 5. 生成的输出文件
- **TXT 输出**：与 LaTeX 输出结构相同。
- **RTF 输出**：与 LaTeX 输出结构相同。
- **Man 输出**：每个标识符生成一个手册页文件。

### 6. 获取更多信息
- 更多信息可访问 [Free Pascal 官网](http://www.freepascal.org/)。
- 对于问题或建议，可联系 `[e-mail]`。

---

以上是文档的核心内容和关键信息的总结，语言简洁明了，逻辑清晰，重点突出。