progress(1) [netbsd man page]

PROGRESS(1)						    BSD General Commands Manual 					       PROGRESS(1)

NAME

     progress -- feed input to a command, displaying a progress bar

SYNOPSIS

     progress [-ez] [-b buffersize] [-f file] [-l length] [-p prefix] cmd [args ...]

DESCRIPTION

     The progress utility opens a pipe to cmd and feeds an input stream into it, while displaying a progress bar to standard output.  If no file-
     name is specified, progress reads from standard input.  Where feasible, progress fstat(2)s the input to determine the length, so a time esti-
     mate can be calculated.

     If no length is specified or determined, progress simply displays a count of the data and the data rate.

     The options are as follows:

     -b buffersize
		  Read in buffers of the specified size (default 64k).	An optional suffix (per strsuftoll(3)) may be given.

     -e 	  Display progress to standard error instead of standard output.

     -f file	  Read from the specified file instead of standard input.

     -l length	  Use the specified length for the time estimate, rather than attempting to fstat(2) the input.  An optional suffix (per
		  strsuftoll(3)) may be given.

     -p prefix	  Print the given ``prefix'' text before (left of) the progress bar.

     -z 	  Filter the input through gunzip(1).  If -f is specified, calculate the length using gzip -l.

EXIT STATUS

     progress exits 0 on success.

EXAMPLES

     The command
	   progress -zf file.tar.gz tar xf -
     will extract the file.tar.gz displaying the progress bar as time passes:

       0% |				  |	0	 0.00 KiB/s    --:-- ETA
      40% |********			  |   273 KiB  271.95 KiB/s    00:01 ETA
      81% |***********************	  |   553 KiB  274.61 KiB/s    00:00 ETA
     100% |*******************************|   680 KiB  264.59 KiB/s    00:00 ETA

     If it is preferred to monitor the progress of the decompression process (unlikely), then
	   progress -f file.tar.gz tar zxf -
     could be used.

     The command
	   dd if=/dev/rwd0d ibs=64k | 
	   progress -l 120g dd of=/dev/rwd1d obs=64k
     will copy the 120 GiB disk wd0 (/dev/rwd0d) to wd1 (/dev/rwd1d), displaying a progress bar during the operation.

SEE ALSO

     ftp(1), strsuftoll(3)

HISTORY

     progress first appeared in NetBSD 1.6.1.  The dynamic progress bar display code is part of ftp(1).

AUTHORS

     progress was written by John Hawkinson <jhawk@NetBSD.org>.  ftp(1)'s dynamic progress bar was written by Luke Mewburn.

BUGS

     Since the progress bar is displayed asynchronously, it may be difficult to read some error messages, both those produced by the pipeline, as
     well as those produced by progress itself.

BSD
								   June 6, 2007 							       BSD

Check Out this Related Man Page

Mail::SpamAssassin::Util::Progress(3pm) 		User Contributed Perl Documentation		   Mail::SpamAssassin::Util::Progress(3pm)

NAME

       Mail::SpamAssassin::Util::Progress - Progress bar support for SpamAssassin

SYNOPSIS

	 my $progress = Mail::SpamAssassin::Util::Progress->new({total => 100});

	 $msgcount = 0;
	 foreach my $message (@messages) {
	   # do something here
	   $msgcount++;
	   $progress->update($msgcount);
	 }

	 $progress->final();

DESCRIPTION

       This module implements a progress bar for use in SpamAssassin scripts and modules.  It allows you to create the progress bar, update it and
       print out the final results of a particular run.

   new
       public class (Mail::SpamAssassin::Util::Progress) new (\% $args)

       Description: Creates a new Mail::SpamAssassin::Util::Progress object, valid values for the $args hashref are:

       total (required)
	   The total number of messages expected to be processed.  This item is required.

       fh [optional]
	   An optional filehandle may be passed in, otherwise STDERR will be used by default.

       term [optional]
	   The module will attempt to determine if a valid terminal exists on the STDIN filehandle.  This item allows you to override that value.

   init_bar
       public instance () init_bar()

       Description: This method creates the initial progress bar and is called automatically from new.	In addition you can call init_bar on an
       existing object to reset the bar to it's original state.

   update
       public instance () update ([Integer $num_done])

       Description: This method is what gets called to update the progress bar.  You may optionally pass in an integer value that indicates how
       many messages have been processed.  If you do not pass anything in then the num_done value will be incremented by one.

   final
       public instance () final ([Integer $num_done])

       Description: This method should be called once all processing has finished.  It will print out the final msgs per sec calculation and the
       total time taken.  You can optionally pass in a num_done value, otherwise it will use the value calculated from the last call to update.

perl v5.14.2							    2011-06-06				   Mail::SpamAssassin::Util::Progress(3pm)

Linux and UNIX Man Pages

progress(1) [netbsd man page]

Check Out this Related Man Page