Long option parsing in Bash Scripting

Introduction

Long option parsing helps scripts understand commands like --help or --version. It makes scripts easier to use and remember.

You want users to run your script with clear options like <code>--file</code> instead of just <code>-f</code>.

Your script needs to accept multiple options with descriptive names.

You want to provide a friendly way to show help or version info.

You want to avoid confusion with short options that look similar.

You want to handle options with or without values, like <code>--output=filename</code>.

Syntax

Bash Scripting

# Use a while loop and case statement to check $1
while [[ "$1" != "" ]]; do
  case $1 in
    --option) # handle option
      ;; 
    --option=*) # handle option with value
      ;; 
    --help) # show help
      ;; 
    *) # unknown option
      ;; 
  esac
  shift
 done

Use shift to move to the next argument after processing one.

Use case to match long options easily.

Examples

Simple example to print messages for --help and --version.

Bash Scripting

while [[ "$1" != "" ]]; do
  case $1 in
    --help)
      echo "Show help"
      ;;
    --version)
      echo "Show version"
      ;;
  esac
  shift
done

Example to get a value from an option like --file=example.txt.

Bash Scripting

while [[ "$1" != "" ]]; do
  case $1 in
    --file=*)
      filename="${1#*=}"
      echo "File is $filename"
      ;;
  esac
  shift
done

Example showing a flag option --verbose and an option with value --output=filename.

Bash Scripting

while [[ "$1" != "" ]]; do
  case $1 in
    --verbose)
      verbose=true
      ;;
    --output=*)
      output_file="${1#*=}"
      ;;
  esac
  shift
done

Sample Program

This script reads long options --verbose and --output=filename. It shows how to handle flags and options with values. It also shows a help message with --help.

Bash Scripting

#!/bin/bash

verbose=false
output_file="default.txt"

while [[ "$1" != "" ]]; do
  case $1 in
    --help)
      echo "Usage: script.sh [--verbose] [--output=filename]"
      exit
      ;;
    --verbose)
      verbose=true
      ;;
    --output=*)
      output_file="${1#*=}"
      ;;
    *)
      echo "Unknown option: $1"
      exit 1
      ;;
  esac
  shift
 done

if $verbose; then
  echo "Verbose mode is ON"
else
  echo "Verbose mode is OFF"
fi

echo "Output file is: $output_file"

Important Notes

Always use quotes around variables like "$1" to avoid errors with spaces.

Use ${1#*=} to get the part after = in options like --output=file.

Remember to shift to move to the next argument after processing one.

Summary

Long option parsing makes scripts easier to use with clear option names.

Use a while loop and case to check each argument.

Handle options with and without values by matching patterns like --option and --option=value.

Practice

1. What is the main advantage of using long option parsing in bash scripts?

easy

A. It makes scripts easier to use with clear option names

B. It speeds up script execution significantly

C. It reduces the number of lines in the script

D. It automatically fixes syntax errors in scripts

Solution

1. Step 1: Understand the purpose of long options

   Long options use descriptive names like --help instead of short flags like -h, making scripts easier to understand.

2. Step 2: Compare benefits

   While long options improve clarity, they do not inherently speed up execution or reduce code length, nor fix syntax errors automatically.

3. Final Answer:

   It makes scripts easier to use with clear option names -> Option A

4. Quick Check:

   Long options improve clarity = D [OK]

Hint: Long options are about clarity, not speed or length [OK]

Common Mistakes:

• Confusing long options with performance improvements
• Thinking long options reduce script size
• Assuming long options fix syntax errors automatically

2. Which of the following is the correct syntax to start parsing long options in a bash script?

easy

A. if [ "$1" == "--help" ]; then echo help; fi

B. while [[ "$1" == --* ]]; do case "$1" in ... ;; esac; shift; done

C. for arg in $@; do if [[ $arg == -* ]]; then ... fi; done

D. while getopts "h" opt; do case $opt in ... ;; esac; done

Solution

1. Step 1: Identify long option parsing pattern

   Long options start with --, so checking if $1 starts with -- in a while loop is correct.

2. Step 2: Analyze options

   while [[ "$1" == --* ]]; do case "$1" in ... ;; esac; shift; done uses while [[ "$1" == --* ]] and case to parse options, which is standard for long options. for arg in $@; do if [[ $arg == -* ]]; then ... fi; done checks short options, A is a single if, and D uses getopts which doesn't support long options.

3. Final Answer:

   while [[ "$1" == --* ]]; do case "$1" in ... ;; esac; shift; done -> Option B

4. Quick Check:

   Long option parsing uses while + case + --* check = C [OK]

Hint: Long options start with --, use while and case to parse [OK]

Common Mistakes:

• Using getopts which only supports short options
• Checking only single dash options
• Not shifting arguments after processing

3. Given this snippet, what will be the output if the script is run with --name=John?

while [[ "$1" == --* ]]; do
  case "$1" in
    --name=*)
      name="${1#*=}"
      ;;
    --help)
      echo "Help requested"
      exit 0
      ;;
  esac
  shift
 done
 echo "Name is $name"

medium

A. Name is

B. Name is --name=John

C. Help requested

D. Name is John

Solution

1. Step 1: Understand parameter expansion

   The pattern --name=* matches --name=John. The expression ${1#*=} removes everything up to and including the first '=' sign, extracting 'John'.

2. Step 2: Follow script flow

   The script assigns 'John' to variable name, shifts arguments, then prints "Name is $name".

3. Final Answer:

   Name is John -> Option D

4. Quick Check:

   Parameter expansion extracts value = A [OK]

Hint: Use ${var#*=} to get value after '=' in long options [OK]

Common Mistakes:

• Printing the whole argument instead of value after '='
• Confusing option with its value
• Not shifting arguments causing infinite loop

4. What is wrong with this long option parsing snippet?

while [[ "$1" == --* ]]; do
  case "$1" in
    --file)
      file="$2"
      shift
      ;;
    --help)
      echo "Help"
      exit 0
      ;;
  esac
  shift
done

medium

A. It should not shift twice in the loop

B. It uses single brackets instead of double brackets

C. It does not check if $2 exists before using it

D. It should use getopts for long options

Solution

1. Step 1: Analyze argument usage

   The script assigns file="$2" without checking if $2 exists, which can cause errors if no value is provided.

2. Step 2: Review other options

   Using double brackets is valid, shifting twice is correct here (once after reading value, once at loop end), and getopts does not support long options well.

3. Final Answer:

   It does not check if $2 exists before using it -> Option C

4. Quick Check:

   Missing check for $2 causes errors = A [OK]

Hint: Always verify next argument exists before using it [OK]

Common Mistakes:

• Not checking if option value is missing
• Confusing shift usage causing argument skipping
• Trying to parse long options with getopts

5. You want to parse long options --user and --password where values can be given as --user=alice or --user alice. Which approach correctly handles both forms in bash?

hard

A. Use case with patterns --user=* and --user, assign value from ${1#*=} or $2 accordingly, shift once or twice

B. Use getopts with "user:" and "password:" options

C. Only accept --user=alice form and reject space-separated values

D. Parse all arguments with a for loop and split on '=' manually

Solution

1. Step 1: Understand option forms

   Long options can be given as --user=alice or --user alice. The script must handle both.

2. Step 2: Implement parsing logic

   Use case with --user=* to get value from ${1#*=}, and --user to get value from next argument $2. Shift accordingly to consume arguments.

3. Step 3: Evaluate other options

   Getopts does not support long options, rejecting space-separated values reduces usability, and manual splitting in a for loop is error-prone.

4. Final Answer:

   Use case with patterns --user=* and --user, assign value from ${1#*=} or $2 accordingly, shift once or twice -> Option A

5. Quick Check:

   Handle both forms with case and shifts = B [OK]

Hint: Match both --option=* and --option, shift args properly [OK]

Common Mistakes:

• Using getopts which lacks long option support
• Ignoring space-separated values
• Not shifting arguments correctly causing errors