Introduction
************

This is the README for `pv' ("Pipe Viewer"), a terminal-based tool for
monitoring the progress of data through a pipeline.  It can be inserted into
any normal pipeline between two processes to give a visual indication of how
quickly data is passing through, how long it has taken, how near to
completion it is, and an estimate of how long it will be until completion.


Documentation
*************

An Info file, manual page, and an HTML manual are all included in this
distribution.  If you have a web browser such as `lynx' handy, you may view
the file `doc/index.html' to get started.  If you prefer plain text, then
look at `doc/quickref.txt' to see the manual page.


Compilation
***********

To compile the package, type "sh ./configure", which should generate a
Makefile for your system.  You may then type "make" to build everything.
Note that GNU `make' is required; this may be installed as `gmake' on some
systems, so if typing "make" gives an error, try "gmake" instead.

See the file `doc/INSTALL' for more about the `configure' script.

Developers note that you can do "./configure --enable-debugging" to cause
debugging support to be built in, and "--enable-profiling" builds in
profiling support (see "man gprof").  Also note that doing "make index" will
generate an HTML code index (using "ctags" and "cproto"); this index lists
all files used, all functions defined, and all TODOs marked in the code.


Author
******

This package is copyright (C) 2005 Andrew Wood, and is being distributed
under the terms of the Artistic License.  For more details, see the file
`doc/COPYING'.

You can contact me by email at andrew.wood@ivarch.com or by using the
contact form on my web page at http://www.ivarch.com/.

The `pv' home page is at:

  http://www.ivarch.com/programs/pv.shtml

The latest version can always be found here.

Credit is also due to:

  Cédric Delfosse <cedric@debian.org>
    - Debian package maintainer

  Eduardo Aguiar <eduardo.oliveira@sondabrasil.com.br>
    - provided Portuguese (Brazilian) translation

  Stéphane Lacasse <tecknojunky@tecknojunky.com>
    - provided French translation

  Marcos Kreinacke <public@kreinacke.com>
    - provided German translation

  Bartosz Feñski <fenio@o2.pl> <http://skawina.eu.org/>
    - provided Polish translation along with Krystian Zubel

  Joshua Jensen
    - reported RPM installation bug

  Boris Folgmann <http://www.folgmann.com/en/>
    - reported cursor handling bug

  Mathias Gumz
    - reported NLS bug

  Daniel Roethlisberger
    - submitted patch to use lockfiles for -c if terminal locking fails

  Adam Buchbinder
    - lots of help with a Cygwin port of -c

-----------------------------------------------------------------------------
