Fastfetch项目文档优化：Manpage增强方案探讨

现状分析

Fastfetch作为一款系统信息查询工具，当前文档系统存在分散化问题。主要文档分布在三个位置：manpage仅包含部分选项说明、命令行帮助(--help)显示更完整选项列表、而GitHub Wiki则存放着JSON Schema等高级配置说明。这种分散的文档结构给用户带来了使用上的不便。

现有问题

1. 文档完整性不足：manpage内容仅为命令行帮助的子集，缺少约40%的选项说明
2. 信息获取效率低：用户需要反复执行fastfetch -h <option>命令查询单个选项详情
3. 学习曲线陡峭：配置文件结构、选项值范围等关键信息缺乏系统说明
4. 文档维护分散：JSON Schema等核心文档存放在外部平台，不利于同步更新

技术解决方案

方案一：基于help2man的自动化生成

该方案利用GNU help2man工具，通过解析fastfetch --help输出自动生成manpage。优势在于实现简单，但存在明显局限：

• 无法包含JSON Schema等扩展内容
• 生成结果受限于命令行帮助的格式
• 缺乏对配置文件的详细说明

方案二：基于Pandoc的多格式转换

采用Pandoc文档转换工具，支持从Markdown等格式生成manpage。技术特点包括：

• 可整合多种文档源（JSON Schema、帮助文本等）
• 支持添加配置示例和选项详解
• 维护单一源文档，生成多种输出格式
• 需要设计合理的文档结构

方案三：定制Python生成脚本

项目维护者提出的推荐方案，核心要求包括：

1. 直接从src/data/help.json生成内容，而非解析--help输出
2. 脚本应输出到stdout，便于构建系统集成
3. 保持生成逻辑透明，便于后续维护

实施建议

对于希望贡献的开发者，建议采用以下实现路径：

1. 数据结构分析：深入研究help.json结构，理解选项分类和组织方式
2. 模板设计：创建合理的roff模板，包含标准manpage结构（NAME、SYNOPSIS等）
3. 内容映射：建立help.json字段到manpage章节的映射关系
4. 扩展整合：设计机制融入JSON Schema和配置示例
5. 构建集成：确保生成脚本能无缝融入现有CMake构建流程

预期效果

完善的manpage文档将包含：

• 所有命令行选项及详细说明
• 配置文件语法和结构详解
• 常用配置示例和最佳实践
• 选项值范围和类型约束
• JSON Schema核心内容

这种集中化的文档方案将显著提升用户体验，减少外部文档依赖，同时降低项目维护成本。