diff --git a/README.md b/README.md index e70768f..1cf9a86 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,16 @@ # 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. +**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 diff --git a/docs/pv.1 b/docs/pv.1 index ba878d9..238ad0c 100644 --- a/docs/pv.1 +++ b/docs/pv.1 @@ -1,7 +1,7 @@ .TH PV 1 2025-10-17 pv-1.9.44 "User Commands" .\" .SH NAME -pv \- monitor the progress of data through a pipe +pv \- monitor and manage the progress of data through a pipe .\" .SH SYNOPSIS .B pv @@ -16,11 +16,15 @@ pv \- monitor the progress of data through a pipe Show the progress of data through a pipeline by giving information such as time elapsed, percentage completed (with progress bar), current throughput rate, total data transferred, and ETA. +The data flow rate, error handling strategy, buffer size, and cache +interaction can all be adjusted. .PP Each \fIFILE\fR is copied to standard output. With no \fIFILE\fR, or when \fIFILE\fR is \*(lq-\*(rq, standard input is read. -This is the same behaviour as \fBcat\fR(1). +.PP +In \*(lq\fB\-\-watchfd\fR\*(rq mode, inspect another process and show its +progress through the files it has open. .\" .SH OPTIONS .\" diff --git a/docs/pv.1.md b/docs/pv.1.md index 5f20bd7..9d4509c 100644 --- a/docs/pv.1.md +++ b/docs/pv.1.md @@ -1,6 +1,6 @@ # NAME -pv - monitor the progress of data through a pipe +pv - monitor and manage the progress of data through a pipe # SYNOPSIS @@ -15,11 +15,15 @@ pv - monitor the progress of data through a pipe Show the progress of data through a pipeline by giving information such as time elapsed, percentage completed (with progress bar), current -throughput rate, total data transferred, and ETA. +throughput rate, total data transferred, and ETA. The data flow rate, +error handling strategy, buffer size, and cache interaction can all be +adjusted. Each *FILE* is copied to standard output. With no *FILE*, or when *FILE* -is "-", standard input is read. This is the same behaviour as -**cat**(1). +is "-", standard input is read. + +In "**\--watchfd**" mode, inspect another process and show its progress +through the files it has open. # OPTIONS