Shell：输出帮助

  • Z时代
  • 2024-01-10
  • 分类：综合

编程

日常执行脚本的时候，时间久了不知道脚本的作用和实行了哪些功能，需要重新看脚本源码。因此，需要对脚本做一下输出帮助。

blog：https://www.cnblogs.com/Rohn/

目录

  • 输出帮助

输出帮助

日常执行脚本的时候，时间久了不知道脚本的作用和实行了哪些功能，需要重新看脚本源码。因此，需要对脚本做一下输出帮助。

执行script.sh -h来显示脚本使用帮助。

格式参考：

###
### 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() {
    sed -rn "s/^### ?//;T;p" "$0"
}
if [[ $# == 0 ]] || [[ "$1" == "-h" ]]; then
    help
    exit 1
fi

sed -rn "s/^### ?//;T;p" "$0"说明：

  • $0：脚本名；

  • -rn：使用扩展元字符集，屏蔽默认输出；

  • s/^### ?//：匹配### 开头的行，并删掉### ；

  • T：若前面替换失败则跳转的sed脚本最后；

  • p：输出替换后的结果；

执行script.sh -h：

[root@test ~]# ./aa.sh -h
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.

原文链接：https://www.cnblogs.com/Rohn/archive/2020/07/18/13336358.html

以上是 Shell：输出帮助 的全部内容， 来源链接： utcz.com/z/518446.html

回到顶部