OnDir 技术文档

1. 安装指南

安装步骤

1. 将 scripts.sh 或 scripts.tcsh 添加到您的 BASH 或 TCSH 启动脚本中。
2. 重启您的 shell。
3. 在 ~/.ondirrc 文件中添加相应的目录条目。
4. 切换到相应的路径。
5. 检查是否成功。

2. 项目的使用说明

OnDir 是一个用于自动化特定目录任务的小程序。当您进入和离开目录时，它会执行目录中的脚本。

• 启动脚本: 根据您的 shell 类型（BASH 或 TCSH），添加相应的启动脚本 (scripts.sh 或 scripts.tcsh)。
• 配置文件: 在 ~/.ondirrc 文件中添加目录条目，并定义进入和离开目录时执行的脚本。

使用示例

假设您在编辑网页时，默认的 umask 是 077，但在 ~/public_html 中创建网页内容时，需要被运行 web 服务器用户可读。通过在 ~/.ondirrc 中为该目录添加路径条目以及对应的进入和离开子条目，您可以在进入和离开目录时执行相应的脚本。

以下是如何在 ~/.ondirrc 中设置条目的示例：

enter /home/athomas/public_html
  umask 022

leave /home/athomas/public_html
  umask 077

这样就完成了。简单而有效。

OnDir 接受一个参数，即您正在离开的目录。请注意，当您通过目录时，这些脚本也会被执行。例如，如果您输入 cd ~/public_html/mywebpage，将会执行 ~/public_html 的 'enter' 脚本。反之亦然：当离开路径时，所有中间目录中的 'leave' 脚本都会被执行。

3. 项目API使用文档

OnDir 的 API 使用非常简单，主要通过 enter 和 leave 指令来定义目录相关的脚本执行。

• enter: 当进入目录时执行的脚本。
• leave: 当离开目录时执行的脚本。

示例

以下是一个使用 OnDir 与 virtualenv 自动激活和停用虚拟环境的示例：

enter ~/Projects/([^/]+)
  if [ -r .venv ]; then
    . ./.venv/bin/activate
  fi

leave ~/Projects/([^/]+)
  deactivate > /dev/null 2>&1

4. 项目安装方式

OnDir 的安装方式如下：

1. 下载 OnDir 源代码。
2. 根据您的 shell 类型，将 scripts.sh 或 scripts.tcsh 添加到启动脚本中。
3. 在 ~/.ondirrc 文件中配置目录和脚本。
4. 重启 shell 并开始使用 OnDir。