Loadable Function: text_waitbar (frac)
Loadable Function: text_waitbar (frac, msg)
Loadable Function: text_waitbar (0, n)

Display text-based waitbar/progress bar.

This function is similar to the waitbar function but is a text, rather than graphical bar. The waitbar is filled to fraction frac which must be in the range [0, 1]. Values exactly equal to 0 or 1 clear the waitbar.

The optional message msg sets the waitbar caption. If Octave is running in a smart terminal, the width is automatically detected, and msg is displayed in the waitbar (and truncated if it is too long). Otherwise, msg is not displayed and the width is initialized to a default of 50 characters, or it can be set to n characters with text_waitbar (0, n). If no terminal is detected (such as when Octave is run in batch mode and output is redirected), no output is generated.

Additional arguments are ignored for compatibility with the graphical counterpart of this function but there are no guarantees of perfect compatibility.

See also: waitbar.

Package: miscellaneous