SHELL

bash Creating help function

#!/bin/bash
############################################################
# Help                                                     #
############################################################
Help()
{
   # Display Help
   echo "Add description of the script functions here."
   echo
   echo "Syntax: scriptTemplate [-g|h|v|V]"
   echo "options:"
   echo "g     Print the GPL license notification."
   echo "h     Print this Help."
   echo "v     Verbose mode."
   echo "V     Print software version and exit."
   echo
}

############################################################
############################################################
# Main program                                             #
############################################################
############################################################
############################################################
# Process the input options. Add options as needed.        #
############################################################
# Get the options
while getopts ":h" option; do
   case $option in
      h) # display Help
         Help
         exit;;
     ?) # Invalid option
         echo "Error: Invalid option"
         exit;;
   esac
done


echo "hello world!"

bash help

man <cmd> 		# for manual of <cmd>, i.e. complete documentation
<cmd> --help  	# for optional parameters
<cmd> -h		# short version of help

apropos <keyword> 	# search for short description for matched instances
					# of the given keyword

apropos sudo		# an example

bash command help

# EXAMPLE
man grep

# SYNTAX
man <command-to-get-help-on>