ivarch/pv

Pipe Viewer - monitor the progress of data through a pipe. https://ivarch.com/p/pv

command-line-tool progress-bar translathon

C 83.4%
Shell 14.5%
M4 1.1%
Makefile 1%

Find a file

Andrew Wood 521391a495 Version bump.		2026-03-07 23:23:35 +00:00
docs	Version bump.	2026-03-07 23:23:35 +00:00
po	Message line number updates.	2026-03-07 23:14:23 +00:00
src	Update the copyright years.	2026-03-07 23:20:20 +00:00
tests	Allow "--size @dir" to read the size of all files under "dir" (#179 ).	2026-03-07 22:23:10 +00:00
.gitignore	Major restructuring to switch build system from old scripts to GNU Automake.	2023-08-28 10:04:39 +01:00
configure.ac	Version bump, and note the change to "--size @x" (#179 ).	2026-03-07 23:23:13 +00:00
Makefile.am	Allow "--size @dir" to read the size of all files under "dir" (#179 ).	2026-03-07 22:23:10 +00:00
README.md	Update the copyright years.	2026-03-07 23:20:20 +00:00

README.md

Introduction

pv ("Pipe Viewer") is a terminal-based tool for monitoring the progress of data through a pipeline and modifying its flow.

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. Data flow rate, error handling strategy, buffer size, and cache interaction can all be adjusted.

In "--watchfd" mode, pv will inspect another process and show its progress through the files it has open.

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".

Developers and translators, please see "docs/DEVELOPERS.md".

Translators can use the Weblate instance hosted by Codeberg: https://translate.codeberg.org/engage/pv/

If you don't see your language listed, raise an issue on the issue tracker (or just email the maintainer) asking for it to be added.

Installation

See "docs/INSTALL" for more about the configure script.

The typical process for a system-wide install is:

sh ./configure --prefix=/usr
make
sudo make install

This requires the build toolchain ("sudo apt install build-essential" on Debian or Ubuntu systems).

If this is not a packaged release, the configure script is not included. It is generated with the GNU build system tools (autoconf, aclocal, autopoint, automake); gettext is also needed. On Debian or Ubuntu, run "sudo apt install automake autopoint gettext". Once those tools are in place, call "autoreconf -is" to generate the configure script, and run it as described above.

Copyright, bug reporting, and acknowledgements

See "docs/ACKNOWLEDGEMENTS.md" for a list of contributors.

License GPLv3+: GNU GPL version 3 or later https://www.gnu.org/licenses/gpl-3.0.html.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License, version 3, in "docs/COPYING". If not, see https://www.gnu.org/licenses/gpl-3.0.html.

Please report bugs or request features via the issue tracker linked from the home page.

The pv home page is at:

https://ivarch.com/p/pv

The latest version can always be found here.