ossp-pkg/shtool/sh.prop 1.17 -> 1.18
--- sh.prop 2004/01/01 16:54:20 1.17
+++ sh.prop 2004/02/12 16:06:27 1.18
@@ -1,7 +1,6 @@
##
## prop -- Display progress with a running propeller
## Copyright (c) 1998-2004 Ralf S. Engelschall <rse@engelschall.com>
-## Originally written for mod_ssl
##
## This file is part of shtool and free software; you can redistribute
## it and/or modify it under the terms of the GNU General Public
@@ -65,3 +64,59 @@
' "prefix=$opt_p"
fi
+shtool_exit 0
+
+##
+## manual page
+##
+
+=pod
+
+=head1 NAME
+
+B<shtool prop> - B<GNU shtool> propeller processing indication
+
+=head1 SYNOPSIS
+
+B<shtool prop>
+[B<-p>|B<--prefix> I<str>]
+
+=head1 DESCRIPTION
+
+This command displays a processing indication though a running
+propeller. It is intended to be run at the end of a pipe ("C<|>")
+sequence where on C<stdin> logging/processing informations found. For
+every line on C<stdin> the propeller advances one step clock-wise.
+
+=head1 OPTIONS
+
+The following command line options are available.
+
+=over 4
+
+=item B<-p>, B<--prefix> I<str>
+
+Set a particular prefix I<str> which is displayed in front of the
+propeller. The default is no prefix string.
+
+=back
+
+=head1 EXAMPLE
+
+ # shell script
+ configure 2>&1 |\
+ tee logfile |\
+ shtool prop -p "Configuring sources"
+
+=head1 HISTORY
+
+The B<GNU shtool> B<prop> command was originally written by Ralf S.
+Engelschall E<lt>rse@engelschall.comE<gt> in 1998 for B<mod_ssl>. It was
+later taken over into B<GNU shtool>.
+
+=head1 SEE ALSO
+
+shtool(1).
+
+=cut
+
|
|
