shtool-prop (1)

Leading comments

Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man1/shtool-prop.1".)

NAME

shtool-prop - GNU shtool propeller processing indication

SYNOPSIS

shtool prop [-p|--prefix str]

DESCRIPTION

This command displays a processing indication though a running propeller. It is intended to be run at the end of a pipe (""|"") sequence where on "stdin" logging/processing information found. For every line on "stdin" the propeller advances one step clock-wise.

OPTIONS

The following command line options are available.

-p, --prefix str

Set a particular prefix str which is displayed in front of the propeller. The default is no prefix string.

EXAMPLE

 #   shell script
 configure 2>&1 |\
     tee logfile |\
     shtool prop -p "Configuring sources"

HISTORY

The shtool prop command was originally written by Ralf S. Engelschall <rse@engelschall.com> in 1998 for mod_ssl. It was later taken over into shtool.

SEE ALSO

shtool(1).