How can I debug a Bash script? [closed]

by 
sh -x script [arg1 ...]
bash -x script [arg1 ...]

These give you a trace of what is being executed. (See also ‘Clarification’ near the bottom of the answer.)

Sometimes, you need to control the debugging within the script. In that case, as Cheeto reminded me, you can use:

set -x

This turns debugging on. You can then turn it off again with:

set +x

(You can find out the current tracing state by analyzing $-, the current flags, for x.)

Also, shells generally provide options ‘-n‘ for ‘no execution’ and ‘-v‘ for ‘verbose’ mode; you can use these in combination to see whether the shell thinks it could execute your script — occasionally useful if you have an unbalanced quote somewhere.

There is contention that the ‘-x‘ option in Bash is different from other shells (see the comments). The Bash Manual says:

  • -x

    Print a trace of simple commands, for commands, case commands, select commands, and arithmetic for commands and their arguments or associated word lists after they are expanded and before they are executed. The value of the PS4 variable is expanded and the resultant value is printed before the command and its expanded arguments.

That much does not seem to indicate different behaviour at all. I don’t see any other relevant references to ‘-x‘ in the manual. It does not describe differences in the startup sequence.

Clarification: On systems such as a typical Linux box, where ‘/bin/sh‘ is a symlink to ‘/bin/bash‘ (or wherever the Bash executable is found), the two command lines achieve the equivalent effect of running the script with execution trace on. On other systems (for example, Solaris, and some more modern variants of Linux), /bin/sh is not Bash, and the two command lines would give (slightly) different results. Most notably, ‘/bin/sh‘ would be confused by constructs in Bash that it does not recognize at all. (On Solaris, /bin/sh is a Bourne shell; on modern Linux, it is sometimes Dash — a smaller, more strictly POSIX-only shell.) When invoked by name like this, the ‘shebang’ line (‘#!/bin/bash‘ vs '#!/bin/sh‘) at the start of the file has no effect on how the contents are interpreted.

The Bash manual has a section on Bash POSIX mode which, contrary to a long-standing but erroneous version of this answer (see also the comments below), does describe in extensive detail the difference between ‘Bash invoked as sh‘ and ‘Bash invoked as bash‘.

When debugging a (Bash) shell script, it will be sensible and sane — necessary even — to use the shell named in the shebang line with the -x option. Otherwise, you may (will?) get different behaviour when debugging from when running the script.

More Related Contents:

  1. What does 2>&1 mean here?
  2. How to reload .bashrc settings without logging out and back in again?
  3. How do I iterate over a range of numbers defined by variables in Bash?
  4. Quick-and-dirty way to ensure only one instance of a shell script is running at a time
  5. What is the purpose of the : (colon) GNU Bash builtin?
  6. Multi-dimensional arrays in Bash
  7. How do I check if a directory exists in a Bash shell script?
  8. Capture stdout and stderr into different variables
  9. How to determine the current interactive shell that I’m in (command-line)
  10. Associative arrays in Shell scripts
  11. How to get the part of a file after the first line that matches a regular expression
  12. Trying to split a string into two variables
  13. Open and write data to text file using Bash?
  14. How do I echo stars (*) when reading password with `read`?
  15. Why is this bash prompt acting strangely/disappearing, and how do I fix it (OS X)?
  16. Why is “[[ 10 < 2 ]]" true when comparing numbers in bash? [duplicate]
  17. Bash: Copy named files recursively, preserving folder structure
  18. How to go to each directory and execute a command?
  19. Read a variable in bash with a default value
  20. Relative paths based on file location instead of current working directory [duplicate]
  21. Counting lines or enumerating line numbers so I can loop over them – why is this an anti-pattern?
  22. Execute command containing quotes from shell variable [duplicate]
  23. What does “export” do in shell programming? [duplicate]
  24. What is the most elegant way to remove a path from the $PATH variable in Bash?
  25. pipe stdout and stderr to two different processes in shell script?
  26. Why equal to operator does not work if it is not surrounded by space?
  27. How can I convert tabs to spaces in every file of a directory?
  28. How to match a single quote in sed
  29. How to update one file in a zip archive
  30. Why doesn’t my terminal output unicode characters properly?

Leave a Comment