开源项目 `when` 使用教程

开源项目 when 使用教程

when run a command until a condition is met, then run another one! 项目地址: https://gitcode.com/gh_mirrors/when2/when

1. 项目的目录结构及介绍

when 项目的目录结构如下：

when/
├── .gitignore
├── HISTORY
├── LICENSE
├── Makefile
├── README
├── retry.c
└── when.c

目录结构介绍

• .gitignore: 用于指定 Git 版本控制系统忽略的文件和目录。
• HISTORY: 记录项目的版本历史和变更记录。
• LICENSE: 项目的开源许可证文件，本项目使用 GPL-3.0 许可证。
• Makefile: 用于编译和构建项目的 Makefile 文件。
• README: 项目的说明文件，包含项目的简介、使用方法和示例。
• retry.c: 项目的源代码文件之一，可能包含与重试逻辑相关的代码。
• when.c: 项目的核心源代码文件，包含 when 命令的实现。

2. 项目的启动文件介绍

when 项目的启动文件是 when.c。该文件实现了 when 命令的核心功能，允许用户在特定条件下重复运行一个命令，直到条件满足后再运行另一个命令。

when.c 文件介绍

• 功能: when.c 文件实现了 when 命令的主要逻辑，包括条件检查、命令执行和错误处理。
• 主要函数:
  • main(): 程序的入口函数，负责解析命令行参数并调用相应的功能函数。
  • run_conditional(): 负责运行条件命令，并根据条件的结果决定是否继续执行。
  • run_command(): 在条件满足后执行指定的命令。

3. 项目的配置文件介绍

when 项目没有专门的配置文件，所有的配置和参数都是通过命令行参数传递的。用户可以通过命令行选项来指定条件检查的间隔时间、成功模式等。

命令行参数介绍

• -n : 设置条件检查的间隔时间（秒）。
• -t: 设置成功模式为“时间炸弹”模式，即条件命令在指定时间内运行成功。
• -z: 设置成功模式为“零返回值”模式，即条件命令返回值为 0 时成功。
• -h: 打印帮助信息并退出。
• -v: 打印版本信息并退出。
• -V: 开启详细输出模式，主要用于调试。

示例

假设你有一个失败的构建任务，你可以使用 when 命令在构建成功时发送通知：

when "make" "xmessage 'hurrah, build passed'"

或者，你可以在用户登录时发送问候：

when "w | grep john" "echo 'hello, john' | write john"

通过这些命令行参数，用户可以灵活地配置 when 命令的行为，以满足不同的需求。

when run a command until a condition is met, then run another one! 项目地址: https://gitcode.com/gh_mirrors/when2/when