keynav 项目技术文档

1. 安装指南

1.1 系统要求

keynav 项目仅支持 X11 图形系统，适用于几乎所有运行 X11 的类 Unix 系统。已确认支持的系统包括：

• GNU/Linux（基于 RPM、Debian、musl 和 Arch 的系统）
• FreeBSD

1.2 依赖库安装

在 Debian 和 Ubuntu 系统上，您需要安装以下依赖库：

sudo apt-get install libcairo2-dev libxinerama-dev libxdo-dev

1.3 编译与安装

1. 克隆或下载 keynav 项目源码。
2. 进入项目目录，运行以下命令进行编译：

   make
   

3. 编译完成后，生成的可执行文件为 ./keynav。您可以直接运行它，或将其复制到系统路径中。
4. 如果您希望将 keynav 安装到系统默认路径（通常为 /usr），可以运行：

   make install
   

1.4 非 GNU 平台

在 FreeBSD 等非 GNU 平台上，您需要使用 gmake 进行编译：

gmake

2. 项目使用说明

2.1 启动 keynav

编译完成后，您可以通过以下命令启动 keynav：

./keynav

启动后，您可以使用键盘控制鼠标移动和点击。

2.2 配置文件

keynav 的配置文件为 keynavrc，您可以根据需要自定义键盘映射和鼠标操作。默认配置文件通常位于用户主目录下。

2.3 鼠标滚动

keynav 支持鼠标滚动操作。X11 将鼠标滚动表示为按键按下，您可以在 keynavrc 中添加相关配置。例如：

• 使用 i 键滚动向上：

  i click 4,end
  

• 使用 e 键滚动向下：

  e click 5,end
  

如果您希望持续滚动而不需要重新调用 keynav，可以移除 end 命令：

i click 4

3. 项目 API 使用文档

keynav 项目本身不提供传统的 API 接口，但其核心功能通过键盘映射和配置文件进行控制。您可以通过编辑 keynavrc 文件来自定义键盘与鼠标操作的映射关系。

3.1 常用命令

• click <button>：模拟鼠标点击，<button> 为鼠标按钮编号（1=左键，2=中键，3=右键，4=滚轮上，5=滚轮下，6=滚轮左，7=滚轮右）。
• end：结束当前操作。

3.2 示例配置

以下是一个简单的 keynavrc 配置示例：

i click 4,end
e click 5,end
space click 1,end

此配置将 i 键映射为向上滚动，e 键映射为向下滚动，space 键映射为鼠标左键点击。

4. 项目安装方式

4.1 源码编译安装

1. 下载或克隆 keynav 项目源码。
2. 安装依赖库（如上文所述）。
3. 运行 make 进行编译。
4. 运行 make install 进行安装（可选）。

4.2 直接运行

编译完成后，您可以直接运行生成的 ./keynav 可执行文件，无需安装到系统路径。

---

通过以上文档，您应该能够顺利安装、配置和使用 keynav 项目。如有任何问题，请参考项目的 FAQ 或联系项目维护者。