From dc51002ba4de6155a586ec05a18a5a0285caeab3 Mon Sep 17 00:00:00 2001 From: Andrew Wood Date: Sun, 19 Apr 2026 00:09:26 +0100 Subject: [PATCH] Reword the introduction, and mention monitor mode. --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6610b55..be90b8e 100644 --- a/README.md +++ b/README.md @@ -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