pPub 技术文档

1. 安装指南

pPub 是一个基于 Python 的简单 ePub 阅读器，使用 GTK3 和 WebKit 构建。以下是不同操作系统的安装方法：

Archlinux

在 Archlinux 上，您可以通过 AUR 安装 pPub：

yay -S ppub

Salix

在 Salix 上，您可以使用以下命令安装 pPub（可能已失效）：

slapt-src -i ppub

其他 Linux 发行版和 BSD

对于其他 Linux 发行版和 BSD，您可以使用以下命令进行安装：

make install

默认情况下，pPub 会安装到 /usr 目录下，并使用 /usr/bin/python2 命令调用 Python 2.x。如果您希望更改安装路径或使用的 Python 版本，可以通过设置环境变量来实现：

PREFIX=/usr/local PYTHON=`which python2.7` make install

如果您只想安装程序本身而不包括图标和桌面文件，可以使用以下命令：

make install-bin

2. 项目的使用说明

pPub 提供了丰富的功能，包括书签、键盘快捷键、目录支持、夜间模式、自定义用户 CSS 支持等。以下是主要功能的使用说明：

书签

pPub 使用 MD5 哈希来存储书签，因此文件名不会影响书签的保存。

键盘快捷键

pPub 支持多种键盘快捷键，方便用户快速操作。

目录支持

pPub 可以显示 ePub 文件的目录，方便用户快速导航。

夜间模式和自定义 CSS

pPub 支持夜间模式，用户还可以通过自定义 CSS 来调整阅读界面的样式。

Javascript 开关

pPub 提供了 Javascript 的开关功能，用户可以根据需要启用或禁用 Javascript。

ebook-convert 支持

pPub 提供了基本的 ebook-convert 支持，方便用户进行格式转换。

配置文件

pPub 的配置文件保存在 ~/.ppub.conf 中，用户可以通过编辑该文件来修改缓存目录和自定义 CSS 路径等设置。

3. 项目 API 使用文档

pPub 目前没有公开的 API 文档，因为它主要是一个桌面应用程序，不提供编程接口。用户可以通过命令行参数来启动 pPub 并打开指定的 ePub 文件：

ppub /path/to/your/book.epub

4. 项目安装方式

pPub 的安装方式已经在第 1 节中详细介绍。用户可以根据自己的操作系统选择合适的安装方法。如果您在安装过程中遇到问题，可以参考项目的 GitHub Wiki 或联系项目的贡献者。

总结

pPub 是一个轻量级的 ePub 阅读器，适合在 Linux 和 BSD 系统上使用。通过本文档，您可以了解如何安装和使用 pPub，以及如何配置其功能。希望 pPub 能为您的阅读体验带来便利。