Using "trap" to react to signals and system events All Versions

Examples

• 17

  Introduction: clean up temporary files

  edit move example delete share

  17

  You can use the trap command to "trap" signals; this is the shell equivalent of the signal() or sigaction() call in C and most other programming languages to catch signals.

  One of the most common uses of trap is to clean up temporary files on both an expected and unexpected exit.

  Unfortunately not enough shell scripts do this :-(

  #!/bin/sh
  
  # Make a cleanup function
  cleanup() {
    rm --force -- "${tmp}"
  }
  
  # Trap the special "EXIT" group, which is always run when the shell exits.
  trap cleanup EXIT
  
  # Create a temporary file
  tmp="$(mktemp -p /tmp tmpfileXXXXXXX)"
  
  echo "Hello, world!" >> "${tmp}"
  
  # No rm -f "$tmp" needed. The advantage of using EXIT is that it still works
  # even if there was an error or if you used exit.
  

  edited Aug 4 '16 at 6:45

  

  

  
• 11

  Catching SIGINT or Ctl+C

  edit move example delete share

  11

  The trap is reset for subshells, so the sleep will still act on the SIGINT signal sent by ^C (usually by quitting), but the parent process (i.e. the shell script) won't.

  #!/bin/sh
  
  # Run a command on signal 2 (SIGINT, which is what ^C sends)
  sigint() {
      echo "Killed subshell!"
  }
  trap sigint INT
  
  # Or use the no-op command for no output
  #trap : INT
  
  # This will be killed on the first ^C
  echo "Sleeping..."
  sleep 500
  
  echo "Sleeping..."
  sleep 500
  

  And a variant which still allows you to quit the main program by pressing ^C twice in a second:

  last=0
  allow_quit() {
      [ $(date +%s) -lt $(( $last + 1 )) ] && exit
      echo "Press ^C twice in a row to quit"
      last=$(date +%s)
  }
  trap allow_quit INT
  

  edited Jul 31 '16 at 15:18

  

  

  
• 8

  Accumulate a list of trap work to run at exit.

  edit move example delete share

  8

  Have you ever forgotten to add a trap to clean up a temporary file or do other work at exit?

  Have you ever set one trap which canceled another?

  This code makes it easy to add things to be done on exit one item at a time, rather than having one large trap statement somewhere in your code, which may be easy to forget.

  # on_exit and add_on_exit
  # Usage:
  #   add_on_exit rm -f /tmp/foo
  #   add_on_exit echo "I am exiting"
  #   tempfile=$(mktemp)
  #   add_on_exit rm -f "$tempfile"
  # Based on http://www.linuxjournal.com/content/use-bash-trap-statement-cleanup-temporary-files
  function on_exit()
  {
      for i in "${on_exit_items[@]}"
      do
          eval $i
      done
  }
  function add_on_exit()
  {
      local n=${#on_exit_items[*]}
      on_exit_items[$n]="$*"
      if [[ $n -eq 0 ]]; then
          trap on_exit EXIT
      fi
  }
  

  edited Aug 17 '16 at 9:16

  

  

  
• 2

  Killing Child Processes on Exit

  edit move example delete share

  2

  Trap expressions don't have to be individual functions or programs, they can be more complex expressions as well.

  By combining jobs -p and kill, we can kill all spawned child processes of the shell on exit:

  trap 'jobs -p | xargs kill' EXIT
  

  edited Jul 28 '16 at 6:48

  
• 0

  react on change of terminals window size

  edit move example delete share

  0

  There is a signal WINCH ( WINdowCHange), which is fired when one resizes a terminal window.

  declare -x rows cols
   
  update_size(){
    rows=$(tput lines) # get actual lines of term
    cols=$(tput cols)  # get actual columns of term
    echo DEBUG terminal window has no $rows lines and is $cols characters wide
  }
  
  trap update_size WINCH
  

  created Aug 22 '16 at 12:59