mirrors/pv
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Cover more of the features in the description.

Browse Source
This commit is contained in:
Andrew Wood
2025-10-17 23:49:08 +01:00
parent f96a43e366
commit 493634e26c
3 changed files with 25 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+11 -5
View File
@@ -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
docs/pv.1
+6 -2
View File
@@ -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
.\"
docs/pv.1.md
+8 -4
View File
@@ -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