cshatag项目技术文档

1. 安装指南

cshatag提供了静态的amd64二进制文件，该文件适用于所有Linux发行版。您可以从以下地址下载：

下载二进制发布版

如果需要自行编译，则需要安装git、Go和make工具。以下是编译步骤：

$ git clone https://github.com/rfjakob/cshatag.git
$ cd cshatag
$ make

2. 项目的使用说明

cshatag是一个用于检测静默数据损坏的工具，它会定期运行并将每个文件的SHA256值存储为扩展属性。此工具需要文件系统挂载时启用user_xattr。

项目兼容shatag工具的格式，并使用相同的扩展属性。

使用cshatag的基本命令如下：

$ cshatag [选项] 文件 [文件...]

以下是可用的选项：

• -dry-run: 不进行任何更改，仅进行模拟运行。
• -recursive: 递归处理目录内容。
• -remove: 从文件中移除cshatag的扩展属性。
• -q: 安静模式 - 不报告状态为<ok>的文件。
• -qq: 更安静的模式 - 仅报告状态为<corrupt>的文件和错误。
• -fix: 修复损坏文件的存储SHA256值。

3. 项目API使用文档

cshatag工具不提供传统意义上的API接口，但是它可以通过命令行参数接收指令，并返回文件校验的状态。用户可以根据返回的状态码来进行进一步的操作。

• 返回值0：成功。
• 返回值1：参数数量错误。
• 返回值2：一个或多个文件无法打开。
• 返回值3：一个或多个文件不是普通文件。
• 返回值4：无法向一个或多个文件写入扩展属性。
• 返回值5：至少有一个文件被发现损坏。
• 返回值6：发生了多种类型的错误。

4. 项目安装方式

如前所述，您可以从项目的GitHub发布页下载预编译的amd64二进制文件，或者按照以下步骤自行编译：

$ git clone https://github.com/rfjakob/cshatag.git
$ cd cshatag
$ make

编译完成后，您可以在本地运行生成的二进制文件。

请确保在运行cshatag之前，您的文件系统支持扩展属性，并且已经正确挂载（通常需要user_xattr选项）。