Differences between revisions 5 and 16 (spanning 11 versions)
⇤ ← Revision 5 as of 2008-11-22 21:38:27 →
Size: 1048
Editor: GreyCat
Comment: first-line
← Revision 16 as of 2023-10-26 18:03:57 → ⇥
Size: 1593
Editor: emanuele6
Comment: check exit status of sleep, and avoid repetition of sleep command
Deletions are marked like this. Additions are marked like this.
Line 6: Line 6:
i=1
sp="/-\|"
echo -n ' '
while true
do
    printf "\b${sp:i++%${#sp}:1}"
done		 # Bash, with GNU sleep
spin() {
  local i=0
  local sp='/-\|'
  local n=${#sp}
  printf ' '
  while sleep 0.1; do
    printf '\b%s' "${sp:i++%n:1}"
  done
}
Line 19: Line 22:
If you want it to slow down, put a {{{sleep}}} command inside the loop (after the printf). To slow it down, the `sleep` command is included inside the loop (after the `printf`).
Line 21: Line 24:
If you already have a loop which does a lot of work, you can call the following function at the beginning of each iteration to update the spinner: A POSIX equivalent would be:
Line 23: Line 27:
sp="/-\|" # POSIX sh
spin() {
  sp='/-\|'
  printf ' '
  while sleep 1; do
    printf '\b%.1s' "$sp"
    sp=${sp#?}${sp%???}
  done
}
}}}

One way to use these spinners in a script is to run them as background processes, and kill them when you're done. For example,

{{{
# POSIX sh
spin & spinpid=$!
# long-running commands here
kill "$spinpid"
}}}

If you already have a loop which does a lot of work, you can write a function that "advances" the spinner one step at a time, and call it at the beginning of each iteration:

{{{
# Bash
sp='/-\|'
Line 25: Line 53:
sn=${#sp}
Line 26: Line 55:
   printf "\b${sp:sc++:1}"
   ((sc==${#sp})) && sc=0		   printf '\b%s' "${sp:sc++%sn:1}"
Line 30: Line 58:
   printf "\r%s\n" "$@"   printf '\r%s\n' "$*"
Line 40: Line 68:
A similar technique can be used to build progress bars. A similar technique can be used to build [[BashFAQ/044|progress bars]].

----
CategoryShell

Can I do a spinner in Bash?

Sure! 

# Bash, with GNU sleep
spin() {
  local i=0
  local sp='/-\|'
  local n=${#sp}
  printf ' '
  while sleep 0.1; do
    printf '\b%s' "${sp:i++%n:1}"
  done
}

Each time the loop iterates, it displays the next character in the sp string, wrapping around as it reaches the end. (i is the position of the current character to display and ${#sp} is the length of the sp string).

The \b string is replaced by a 'backspace' character. Alternatively, you could play with \r to go back to the beginning of the line.

To slow it down, the sleep command is included inside the loop (after the printf).

A POSIX equivalent would be: 

# POSIX sh
spin() {
  sp='/-\|'
  printf ' '
  while sleep 1; do
    printf '\b%.1s' "$sp"
    sp=${sp#?}${sp%???}
  done
}

One way to use these spinners in a script is to run them as background processes, and kill them when you're done. For example, 

# POSIX sh
spin & spinpid=$!
# long-running commands here
kill "$spinpid"

If you already have a loop which does a lot of work, you can write a function that "advances" the spinner one step at a time, and call it at the beginning of each iteration: 

# Bash
sp='/-\|'
sc=0
sn=${#sp}
spin() {
    printf '\b%s' "${sp:sc++%sn:1}"
}
endspin() {
    printf '\r%s\n' "$*"
}

until work_done; do
   spin
   some_work ...
done
endspin

A similar technique can be used to build progress bars.

CategoryShell

BashFAQ/034 (last edited 2023-10-26 18:03:57 by emanuele6)