Shell:输出帮助

Posted 时间之旅

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Shell:输出帮助相关的知识,希望对你有一定的参考价值。

Blog:博客园 个人

输出帮助

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

执行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.

以上是关于Shell:输出帮助的主要内容,如果未能解决你的问题,请参考以下文章

Shell:输出帮助

shell选取部分内容

代码片段:Shell脚本实现重复执行和多进程

Unix shell输入输出重定向

需要示例代码片段帮助

Linux 获取命令的帮助信息