如何将帮助方法添加到shell脚本中？

Question

如何检查-h属性是否已传递到shell脚本中？我想在用户拨打myscript.sh -h时显示帮助信息。

Answer 1

这里是对于bash的例子：

usage="$(basename "$0") [-h] [-s n] -- program to calculate the answer to life, the universe and everything 

where: 
    -h show this help text 
    -s set the seed value (default: 42)" 

seed=42 
while getopts ':hs:' option; do 
    case "$option" in 
    h) echo "$usage" 
     exit 
     ;; 
    s) seed=$OPTARG 
     ;; 
    :) printf "missing argument for -%s\n" "$OPTARG" >&2 
     echo "$usage" >&2 
     exit 1 
     ;; 
    \?) printf "illegal option: -%s\n" "$OPTARG" >&2 
     echo "$usage" >&2 
     exit 1 
     ;; 
    esac 
done 
shift $((OPTIND - 1)) 

Answer 2

最好使用bash的getopt设施。请看看这个问答&用于更多的帮助：Using getopts in bash shell script to get long and short command line options

Answer 3

的第一个参数一个shell脚本可以作为变量$1，所以最简单的实现将是

if [ "$1" == "-h" ]; then 
    echo "Usage: `basename $0` [somestuff]" 
    exit 0 
fi 

但说了什么anubhava。

Answer 4

如果你只有一个选项，以检查它永远是第一个选项（$1），那么最简单的方法是if与测试（[） 。例如：

if [ "$1" == "-h" ] ; then 
    echo "Usage: `basename $0` [-h]" 
    exit 0 
fi 

注意，对于POSIX兼容=将工作以及==。

原因需要$1被引号括起来的是，如果没有$1那么shell将尝试运行if [ == "-h" ]和失败，因为==只被给予当它被期待两个单独的参数：

$ [ == "-h" ] 
bash: [: ==: unary operator expected 

作为suggestedbyothers，如果你有多个简单的选项，或者需要你的选项来接受参数，那么你一定要去使用getopts的额外复杂性。作为快速参考，我喜欢The 60 second getopts tutorial。 ^＆dagger;

您可能还想考虑getopt程序，而不是内置的shell getopts。它允许在非选项参数（例如foo a b c -v而不仅仅是foo -v a b c）之后使用长选项和选项。 This Stackoverflow answer说明如何使用GNU getopt。

^{＆dagger; jeffbyrnes提到original link已经死亡，但幸好0123Å已将其归档。}

Answer 5

我认为你可以使用情况下这...

case $1 in 
-h) echo $usage ;; 
    h) echo $usage ;; 
help) echo $usage ;; 
esac 

Answer 6

这里是我用它来启动VNC服务器

#!/bin/bash 
start() { 
echo "Starting vnc server with $resolution on Display $display" 
#your execute command here mine is below 
#vncserver :$display -geometry $resolution 
} 

stop() { 
echo "Killing vncserver on display $display" 
#vncserver -kill :$display 
} 

######################### 
# The command line help # 
######################### 
display_help() { 
    echo "Usage: $0 [option...] {start|stop|restart}" >&2 
    echo 
    echo " -r, --resolution   run with the given resolution WxH" 
    echo " -d, --display    Set on which display to host on " 
    echo 
    # echo some stuff here for the -a or --add-options 
    exit 1 
} 

################################ 
# Check if parameters options # 
# are given on the commandline # 
################################ 
while : 
do 
    case "$1" in 
     -r | --resolution) 
      if [ $# -ne 0 ]; then 
      resolution="$2" # You may want to check validity of $2 
      fi 
      shift 2 
      ;; 
     -h | --help) 
      display_help # Call your function 
      exit 0 
      ;; 
     -d | --display) 
      display="$2" 
      shift 2 
      ;; 

     -a | --add-options) 
      # do something here call function 
      # and write it in your help function display_help() 
      shift 2 
      ;; 

     --) # End of all options 
      shift 
      break 
      ;; 
     -*) 
      echo "Error: Unknown option: $1" >&2 
      ## or call function display_help 
      exit 1 
      ;; 
     *) # No more options 
      break 
      ;; 
    esac 
done 

###################### 
# Check if parameter # 
# is set too execute # 
###################### 
case "$1" in 
    start) 
    start # calling function start() 
    ;; 
    stop) 
    stop # calling function stop() 
    ;; 
    restart) 
    stop # calling function stop() 
    start # calling function start() 
    ;; 
    *) 
# echo "Usage: $0 {start|stop|restart}" >&2 
    display_help 

exit 1 
;; 

这是一个有点怪异，我放在一个部分在一个单独的情况下启动停止重启，但它应该工作

Answer 7

我只需上传在线手册文件，并用curl检索它。例如，下面的代码是从Github获取的。

####################################### 
    # Show help 
    # 
    # Globals: 
    # None 
    # Arguments: 
    # None 
    # Returns: 
    # None 
    # 
    ####################################### 
    show_help() { 
     curl https://raw.githubusercontent.com/KENJU/shellscript_todo/master/MANUAL | less 
    }