Reword the introduction, and mention monitor mode.

This commit is contained in:
Andrew Wood
2026-04-19 00:09:26 +01:00
parent 9bc5903337
commit dc51002ba4
+10 -5
View File
@@ -3,15 +3,20 @@
**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.
When used just like "**cat**", **pv** displays how quickly data is being
transferred, 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.
With the "**\--cursor**" option, several **pv** instances can work together,
showing transfer progress at different points in the same pipeline.
In "**\--watchfd**" mode, **pv** will inspect another process and show its
progress through the files it has open.
In "**\--monitor**" mode, **pv** will run a command and display the progress
of data through both its standard input and its standard output.
# Documentation