使用Shell显示脚本使用帮助

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

执行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.
posted @   MR__Wang  阅读(150)  评论(0编辑  收藏  举报
编辑推荐:
· AI与.NET技术实操系列:基于图像分类模型对图像进行分类
· go语言实现终端里的倒计时
· 如何编写易于单元测试的代码
· 10年+ .NET Coder 心语,封装的思维:从隐藏、稳定开始理解其本质意义
· .NET Core 中如何实现缓存的预热?
阅读排行:
· 25岁的心里话
· 闲置电脑爆改个人服务器(超详细) #公网映射 #Vmware虚拟网络编辑器
· 零经验选手,Compose 一天开发一款小游戏!
· 因为Apifox不支持离线,我果断选择了Apipost!
· 通过 API 将Deepseek响应流式内容输出到前端
历史上的今天:
2018-12-10 win10 同步批处理禁用和启用网卡
点击右上角即可分享
微信分享提示