1.9 KiB
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
A manual page is included in this distribution ("man pv"). Before
installation, it is in "docs/pv.1".
Changes are listed in "docs/NEWS.md". The to-do list is "docs/TODO.md".
Developers and translators, please see "docs/DEVELOPERS.md".
Compilation
To compile the package, type "sh ./configure", which should generate a
Makefile for your system. You may then type "make" to build everything,
and "make install" to install it.
See the file "docs/INSTALL" for more about the configure script.
If this is not a packaged release, you will need the GNU build system tools
(autoconf, aclocal, autopoint, automake) and the gettext
development tools. You can then run "autoreconf -is" to generate the
"configure" script.
Author and acknowledgements
This package is copyright 2023 Andrew Wood, and is being distributed under the terms of the Artistic License 2.0. For more details of this license, see the file "docs/COPYING".
Please report any bugs to pv@ivarch.com, or use the issue tracker linked from the pv home page.
The pv home page is at:
https://www.ivarch.com/programs/pv.shtml
The latest version can always be found here.
Please see "docs/ACKNOWLEDGEMENTS.md" for a list of contributors.