shell 编程 帮助功能的实现

一个程序,往往需要帮助说明.
激活帮助说明的方法介绍两种
1. 最简单的办法是通过参数个数判别.例如不带任何参数就显示帮助说明.
2. 正规做法是命令行后跟 -h 参数.
shell 帮助的写法可以用一堆echo 指令向控制台输出, 更好的做法是用
here doc 语法, 说明文档排版整齐,跟输出一致. 没有一堆echo 及 双引号等.
下面给出实例:

1. 简单方法
#!/bin/bash -
set -o nounset                              # Treat unset variables as an error
help()
{
    cat <<- EOF
    Desc: 该程序用来....
    Usage: ./1.sh <filename>
    Author: hjjdebug
    License: ...
EOF
    exit 0
}
if [ $# -lt 1 ] # 这里是数值比较,不能用 <, <是字符串比较,跟c语言有点差别.
then
    help
fi

2. 正规方法
#!/bin/bash -
#set -o nounset                              # 这个选项关闭吧,否则$1无定义它报语法错.影响视觉.
help()
{
    cat <<- EOF
    Desc: 该程序用来....
    Usage: ./1.sh <filename>
    Author: hjjdebug
    License: ...
EOF
    exit 0
}

#这里通过判断$1是否存在判别,也可以通过$#判别,shift会改变两者的值,
while [ -n "$1" ]; do
    case $1 in
        -h) help;; # function help is called
        --) shift;break;; # end of options
        -*) echo "error: no such option $1."; exit 1;;
        *) break;;
esac
done

here doc 另外的两点说明：

# here doc
function CreateZeroTxt
{
    cat <<-EOF > zero.txt
    0,0,0,270,
EOF
}

1. 用here doc 创建zero.txt 文件， 在cat后面加上>重定向即可.如上例生成zero.txt

2. 对于文档内容，如果你想忽略前导空白符，即字符靠左排列，加上-即可，如上例。

    注意: 实验发现，只是忽略tab 前导，空格是不忽略的.