bitpocket 技术文档

1. 安装指南

用户可以通过以下两种方式安装 bitpocket：

• 克隆仓库并创建 bin 目录的符号链接到 $PATH 中：

  $ git clone git://github.com/ku1ik/bitpocket.git
  $ ln -s `pwd`/bitpocket/bin/bitpocket ~/bin/bitpocket
  

• 下载脚本并放置在 $PATH 中的目录：

  $ curl -sL https://raw.github.com/ku1ik/bitpocket/master/bin/bitpocket > ~/bin/bitpocket
  $ chmod +x ~/bin/bitpocket
  

设置主副本

在具有 SSH 访问权限的服务器上创建一个空目录，作为文件的主副本：

$ ssh [e-mail]
$ mkdir ~/BitPocketMaster

设置从副本

在每个需要同步的机器上，初始化一个空目录作为 bitpocket：

$ mkdir ~/BitPocket
$ cd ~/BitPocket
$ bitpocket init [e-mail] ~/BitPocketMaster

2. 项目使用说明

安装完成后，使用 bitpocket 命令进行同步和其他任务。运行 bitpocket help 将显示以下帮助信息：

用法: bitpocket { init [<REMOTE_HOST>] <REMOTE_PATH>
                  | sync | help | pack | log | cron | list }

可用的命令:
  sync    运行同步过程。如果没有指定命令，默认运行同步。
  init    初始化一个新的 bitpocket 文件夹。需要路径和可选的远程主机参数。远程路径必须已存在。
  pack    将任何现有的（自动）备份打包到 git 仓库中。
  cron    运行针对 cron 优化的同步，将输出重定向到文件而不是 stdout。
  log     显示由 cron 命令生成的日志。
  list    列出同步集中的所有文件（遵守 include/exclude/filter 配置）。
  help    显示此消息。

注意：除了 help 之外的所有命令，都必须在新的或现有的 bitpocket 目录结构的根目录下运行。

3. 项目API使用文档

bitpocket 的命令行接口是其主要的API。以下是一些常用命令及其用途：

• bitpocket sync：同步本地从副本与主副本。
• bitpocket init：初始化一个新的从副本。
• bitpocket pack：将备份文件打包到 git 仓库中。
• bitpocket cron：优化用于 cron 的同步操作。
• bitpocket log：显示 cron 命令生成的日志。
• bitpocket list：列出将要同步的文件。

更多关于命令的详细用法，可以查看项目帮助信息。

4. 项目安装方式

项目的安装方式已在“安装指南”部分详细说明，以下是简要步骤：

• 克隆仓库或下载脚本。
• 创建符号链接到 $PATH 中。
• 在服务器上创建主副本目录。
• 在本地机器上初始化从副本。

以上步骤提供了从安装到初始化的完整流程。