博主 @reconquestio发了一篇文章 Help message for shell scripts展示一个技巧,将帮助信息写在 Bash 脚本脚本的头部,然后只要执行"脚本名 + help",就能输出这段帮助信息。我翻译了一下,权做参考。
把所有的帮助信息写在脚本的最开始:
#!/bin/bash
###
### my-script — does one thing well
###
### Usage:
### my-script <input> <output>
###
### Options:
### <input> Input file to read.
### <output> Output file to write. Use '-' for stdout.
### -h Show this message.
然后help
函数这么写:
help() {
sed -rn 's/^### ?//;T;p' "$0"
}
调用help
函数:
if [[ \(# 0 ]] || [[ "\)1" </mark> "-h" ]]; then
help
exit 1
fi
完整的例子可以参考作者的
gist