FSEvents Tools 技术文档

本文档将详细介绍如何安装、使用以及通过API操作 FSEvents Tools 项目。

1. 安装指南

1.1 系统要求

FSEvents Tools 是专为 macOS 系统设计的命令行工具，需要运行在 OS X 系统上。

1.2 安装步骤

1. 安装依赖：首先确保系统中已安装 automake、autoconf 和 pkg-config。可以使用 Homebrew 进行安装：

   brew install automake autoconf pkg-config
   

2. 克隆项目：从 GitHub 克隆 FSEvents Tools 仓库到本地：

   git clone https://github.com/ggreer/fsevents-tools.git
   

3. 编译安装：进入项目目录，执行以下命令编译并安装：

   cd fsevents-tools
   ./autogen.sh
   make install
   

   根据权限情况，make install 可能需要使用 sudo。

1.3 构建发布压缩包

构建发布压缩包时，需要同样的依赖，但不需要 automake 和 pkg-config。安装完依赖后，执行以下命令：

./configure
make
make install

2. 项目的使用说明

FSEvents Tools 包含一组命令行工具和脚本，利用 OS X 的 FSEvents API 来监听目录变化并作出响应。以下是一些使用示例：

2.1 监听目录变化并发出提醒

notifywait /path/; echo "\007"

2.2 当 styles 目录下有任何变化时，重新构建 LESS

假设你有一个 rebuild_less.sh 脚本：

#!/bin/bash
for less_file in styles/*.less
do
  css_file=`echo $less_file | sed -E "s/.less//"`
  lessc $less_file $css_file.css
done

只需运行：

notifyloop styles ./rebuild_less.sh

2.3 文件变化时自动同步到远程服务器

autorsync . 192.168.1.127:/var/www

上面的命令会调用 rsync 命令，使用 -avz 参数（归档模式、详细、压缩）。如果要传递额外的参数给 rsync，例如：

RSYNC_OPTS='--exclude="*.pyc"' autorsync . 192.168.1.127:/var/www

手动执行相同的操作：

notifyloop . rsync -avz --exclude="*.pyc" . 192.168.1.127:/var/www

3. 项目API使用文档

FSEvents Tools 的API主要是通过命令行参数进行操作。具体使用方法请参考上面提供的示例。

4. 项目安装方式

项目的安装方式已在“1. 安装指南”部分详细说明。简要概括，包括安装依赖、克隆项目、编译和安装步骤。

---

本文档旨在帮助用户更好地理解和使用 FSEvents Tools，如需更多帮助，请参考官方文档或社区。