debiman 项目使用教程

1. 项目目录结构及介绍

debiman 项目的目录结构如下：

debiman/
├── assets/
├── cmd/
├── example/
├── internal/
├── testdata/
├── LICENSE
├── PERFORMANCE.md
├── README.md
├── bundle.go
├── debiman-auxserver.service
├── debiman-logo.svg
├── go.mod
├── go.sum
├── goembed.go

目录介绍

• assets/: 包含项目的静态资源文件，如 HTML 模板和样式文件。
• cmd/: 包含项目的命令行工具和主程序的源代码。
• example/: 包含示例配置文件和使用示例。
• internal/: 包含项目的内部实现代码，通常不对外公开。
• testdata/: 包含测试数据和测试用例。
• LICENSE: 项目的开源许可证文件。
• PERFORMANCE.md: 项目性能相关的文档。
• README.md: 项目的主文档，包含项目的基本介绍和使用说明。
• bundle.go: 项目的打包文件。
• debiman-auxserver.service: 辅助服务的服务文件。
• debiman-logo.svg: 项目的 Logo 文件。
• go.mod: Go 模块文件，定义项目的依赖关系。
• go.sum: Go 模块的校验和文件。
• goembed.go: 用于嵌入静态资源的 Go 文件。

2. 项目启动文件介绍

debiman 项目的主要启动文件位于 cmd/ 目录下。以下是主要的启动文件：

• cmd/debiman/: 这是 debiman 的主程序文件，负责生成静态的 manpage HTML 仓库。
• cmd/debiman-minisrv/: 这是一个简单的 HTTP 服务器，用于在开发环境中测试生成的 manpage HTML 文件。

启动命令

在开发环境中，可以使用以下命令启动 debiman 主程序：

~/go/bin/debiman -serving_dir=~/man -only_render_pkgs=qelectrotech,i3-wm,cron

在生产环境中，建议使用 debiman-minisrv 来启动服务：

~/go/bin/debiman-minisrv -serving_dir=~/man

3. 项目配置文件介绍

debiman 项目的配置文件主要通过命令行参数进行配置。以下是一些常用的配置选项：

• -serving_dir: 指定生成的 manpage HTML 文件的存储目录。
• -only_render_pkgs: 指定需要渲染的特定包，多个包之间用逗号分隔。
• -sync_codenames: 指定需要同步的 Debian 版本名称。
• -sync_suites: 指定需要同步的 Debian 套件名称。
• -local_mirror: 指定本地 Debian 镜像的路径。

示例配置

以下是一个示例配置命令，用于同步 Debian 的测试和 unstable 版本：

flock /srv/manpages.debian.org/debiman/exclusive.lock \
nice -n 5 \
ionice -n 7 \
debiman \
-sync_codenames=oldstable,oldstable-backports,stable,stable-backports \
-sync_suites=testing,unstable,experimental \
-serving_dir=/srv/manpages.debian.org/www \
-local_mirror=/srv/mirrors/debian

这个命令会生成对应版本的 manpage HTML 文件，并存储在指定的目录中。

---

通过以上步骤，您可以了解 debiman 项目的目录结构、启动文件和配置文件的使用方法。希望这篇教程对您有所帮助！