FB2Converter 使用教程

1. 项目目录结构及介绍

FB2Converter 是一个用于将 FB2 格式的电子书转换为 EPUB2、KEPUB、MOBI 和 AZW3 格式的开源项目。项目的目录结构如下：

fb2converter/
├── cmd/
│   ├── fb2epub/
│   │   └── main.go        # FB2 转换为 EPUB 的主程序
│   ├── fb2mobi/
│   │   └── main.go        # FB2 转换为 MOBI 的主程序
├── config/
│   └── config.go          # 配置文件处理逻辑
├── docs/
│   └── README.md          # 项目说明文件
├── go.mod                # Go 依赖管理文件
├── go.sum                # Go 依赖校验文件
├── LICENSE               # 项目许可证文件
└── misc/
    ├── format.go         # 格式化处理逻辑
    └── version.go        # 版本信息逻辑

• cmd/ 目录包含项目的可执行入口文件。
• config/ 目录包含配置文件的处理逻辑。
• docs/ 目录包含项目的文档和说明。
• go.mod 和 go.sum 文件用于管理项目的 Go 语言依赖。
• LICENSE 文件包含了项目的开源许可证。
• misc/ 目录包含一些辅助功能模块。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/fb2epub/main.go 和 cmd/fb2mobi/main.go。以下是 fb2epub/main.go 的基本结构：

package main

import (
    "fmt"
    "log"
    "os"
    // 导入其他需要的包
)

func main() {
    // 设置日志前缀
    log.SetPrefix("\n*** ")

    // 打印使用说明
    usage()

    // 以下为主要的程序逻辑
}

func usage() {
    // 打印版本信息和使用方法
    fmt.Fprintf(os.Stderr, "\nMyHomeLib wrapper for fb2 converter\nVersion %s (%s) : %s\n\n", misc.GetVersion(), runtime.Version(), misc.GetGitHash())
    fmt.Fprintf(os.Stderr, "Usage: %s <from fb2> <to epub>\n", os.Args[0])
}

启动文件包含了程序的主入口函数 main()，它会设置日志格式、打印使用说明，并执行转换操作。

3. 项目的配置文件介绍

项目的配置文件用于设置转换过程中的一些参数。配置文件可以是 YAML、TOML 或 JSON 格式。以下是一个示例配置文件的内容：

# config.yaml
output_path: ./output
output_format: epub
keep_original: false

这个配置文件指定了输出路径、输出格式以及是否保留原始文件。

在程序运行时，可以通过命令行参数 --config FILE 来指定配置文件的路径。例如：

fb2c convert --config config.yaml /path/to/input.fbb /path/to/output

这样，程序就会按照配置文件中的设置进行转换操作。