Comment puis-je ajouter une aide de la méthode à un script shell?

Comment puis-je vérifier si un -h attribut a été passée dans un script shell? Je voudrais afficher un message d'aide lorsqu'un utilisateur appelle myscript.sh -h.

InformationsquelleAutor tttppp | 2011-03-29
  1. 139

    voici un exemple pour 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))

    Pour utiliser cette l'intérieur d'une fonction:

    • utilisation "$FUNCNAME" au lieu de $(basename "$0")
    • ajouter local OPTIND OPTARG avant d'appeler getopts
    • Je suis en train d'essayer ceci à l'intérieur d'une fonction, mais lorsque j'essaie d'exécuter la fonction, j'obtiens cette erreur "basename: invalid option -- 'b'". On dirait qu'il tente de faire passer pour "-bash" à basename avec le premier tableau de bord.
    • imside une fonction de l'utilisation "$FUNCNAME" pas "$0". Aussi, ajouter local OPTIND OPTARG
    • Merci. FUNCNAME œuvres. J'ai tous mes fonctions à l'intérieur d'un seul fichier, donc c'est parfait pour les étendant en quelque chose d'utile pour les autres.
    • Le usage texte non formaté.
    • assurez-vous que vous citez "$usage" tous place de l'utiliser.
    InformationsquelleAutor glenn jackman
  2. 39

    Le premier argument d'un script shell est disponible en tant que variable $1, donc le plus simple de mise en œuvre seraient 

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

    Mais ce anubhava dit.

    • Merci @MarkBooth, faute de frappe corrigée (ainsi qu'à l'amélioration en les enveloppant dans des guillemets)
    • Vous devriez prendre l'habitude d'emballage de la si dans les [[ ... ]] pour des conditions afin d'éviter une mauvaise analyse d'une variable, source: github.com/bahamas10/bash-style-guide#bashisms
    • Oui, bien que l'OP ne spécifiez pas de bash, et [ est conforme à POSIX version.
    • Remarque - Pour utiliser à l'intérieur des function: Vous devez remplacer exit 0 avec return si vous ne voulez pas mettre fin à votre shell après l'exécution de votre fonction. (Je l'ai fait avant de )
    InformationsquelleAutor seb
  3. 21

    ici est une partie-je l'utiliser pour démarrer un serveur 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
;;

    C'est un peu bizarre que j'ai placé la start stop redémarrer dans un autre cas, mais il devrait fonctionner

    • si vous donnez une option vide à -d; n'est-ce pas une boucle infinie?
    InformationsquelleAutor Vincent Stans
  4. 13

    Si vous n'avez qu'une seule option pour vérifier et il le sera toujours la première option ($1) puis l'option la plus simple est une if avec un test ([). Par exemple:

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

    Noter que pour la compatibilité posix = fonctionnera aussi bien que ==.

    La raison pour laquelle le $1 doit être entre guillemets, c'est que si il n'y a pas de $1 alors le shell va essayer de courir if [ == "-h" ] et échouer parce == a été seulement donné un seul argument quand on s'attendait à deux:

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

    Comme suggéré par d'autres, si vous avez plus d'une option simple, ou besoin de vos options pour accepter des arguments, alors vous devriez certainement aller pour le supplément de la complexité de l'utilisation de getopts. Comme un guide de référence rapide, j'aime 60 deuxième getopts tutoriel.†

    Vous pouvez également envisager de la getopt programme au lieu de construit dans le shell getopts. Il permet l'utilisation de longue options et les options après non les arguments d'option (par exemple, foo a b c -v plutôt que de simplement foo -v a b c). Cette Stackoverflow répondre explique comment utiliser GNU getopt.

    † jeffbyrnes mentionné que le original link est mort, mais heureusement, le machine à remonter le temps avait archivé-il.

    • Merci! J'ai été heureux à l'aide de getopts depuis un an maintenant, mais je vais jeter un coup d'oeil à getopt trop.
    • Malheureusement, le lien vers le 60 Second getopts Tutoriel est mort; il semble que bashcurescancer.com n'est plus. Voici un lien vers le Wayback Machine version.
    InformationsquelleAutor Mark Booth
  5. 5

    Mieux utiliser getopt installation de bash. S'il vous plaît regardez cette Q&A pour plus d'aide: À l'aide de getopts en shell bash script pour obtenir de longue et de courte options de ligne de commande

    InformationsquelleAutor anubhava
  6. -1

    je pense que vous pouvez utiliser pour ce...

    case $1 in 
 -h) echo $usage ;; 
  h) echo $usage ;;
help) echo $usage ;;
esac
    InformationsquelleAutor new user
  7. -2

    Je il suffit de télécharger le Manuel en Ligne du fichier et le récupérer avec curl.
    Par exemple, le code ci-dessous est de la récupération à partir de Github. 

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