Watershot 项目技术文档

Watershot 项目技术文档

1. 安装指南

1.1 通过 AUR 安装

如果你使用的是基于 Arch Linux 的发行版，可以通过 AUR 安装 Watershot。你可以选择安装稳定版本 watershot 或最新开发版本 watershot-git。

yay -S watershot
# 或者
yay -S watershot-git

1.2 通过 Nix 安装

如果你使用的是 NixOS 或支持 Nix 包管理器的系统，可以直接使用项目的 flake 进行安装。

nix profile install github:Kirottu/watershot

1.3 手动安装

1.3.1 依赖项

在手动安装之前，请确保系统中已经安装了以下依赖项：

• fontconfig
• pkgconfig
• libxkbcommon

对于 Nix 系统，这些依赖项会在 flake.nix 中自动处理。

1.3.2 安装步骤

1. 克隆项目仓库：

   git clone https://github.com/Kirottu/watershot
   cd watershot
   

2. 使用 Cargo 安装：

   cargo install --path .
   

   如果你使用的是非标准路径的 grim 工具，可以通过 --grim 或 -g 参数指定路径。

2. 项目使用说明

2.1 基本使用

只需运行可执行文件即可启动 Watershot。默认情况下，截图不会保存或复制到任何地方。

watershot

2.2 命令行选项

• path: 指定保存截图的路径。
• directory: 指定保存截图的目录，文件名将自动生成。
• help: 打印帮助信息。

2.3 常用选项

• -c, --copy: 截图后复制到剪贴板。
• -s, --stdout: 将截图输出到标准输出，格式为 PNG。
• -g, --grim <GRIM>: 指定 grim 可执行文件的路径。
• -h, --help: 打印帮助信息。
• -V, --version: 打印版本信息。

3. 项目 API 使用文档

Watershot 提供了简单的命令行接口，用户可以通过命令行参数来控制截图的行为。以下是一些常用的 API 示例：

3.1 保存截图到指定路径

watershot path /home/user/screenshot.png

3.2 保存截图到指定目录

watershot directory /home/user/screenshots

3.3 复制截图到剪贴板

watershot -c

3.4 输出截图到标准输出

watershot -s > screenshot.png

4. 项目安装方式

Watershot 支持多种安装方式，包括通过 AUR、Nix 以及手动安装。每种方式都有其特定的依赖项和安装步骤。

4.1 通过 AUR 安装

适用于 Arch Linux 及其衍生发行版，安装简单快捷。

4.2 通过 Nix 安装

适用于 NixOS 或支持 Nix 包管理器的系统，依赖项自动处理。

4.3 手动安装

适用于所有支持 Rust 的系统，但需要手动安装依赖项。

通过以上步骤，你可以轻松安装并使用 Watershot 进行截图操作。