Renamed README to README.md and altered it to Markdown format; moved contributors from the README to docs/ACKNOWLEDGEMENTS.md
This commit is contained in:
Andrew Wood
@@ -1,270 +0,0 @@
|
||||
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.
|
||||
|
||||
|
||||
Documentation
|
||||
*************
|
||||
|
||||
A manual page is included in this distribution. See `man ./doc/quickref.1',
|
||||
or `man pv' after installation.
|
||||
|
||||
|
||||
Compilation
|
||||
***********
|
||||
|
||||
If this is not a packaged release, first run "./generate.sh".
|
||||
|
||||
To compile the package, type "sh ./configure", which should generate a
|
||||
Makefile for your system. You may then type "make" to build everything.
|
||||
Note that GNU `make' is required; this may be installed as `gmake' on some
|
||||
systems, so if typing "make" gives an error, try "gmake" instead.
|
||||
|
||||
See the file `doc/INSTALL' for more about the `configure' script.
|
||||
|
||||
Developers note that you can do "./configure --enable-debugging" to cause
|
||||
debugging support to be built in, and "--enable-profiling" builds in
|
||||
profiling support (see "man gprof"). Also note that doing "make index" will
|
||||
generate an HTML code index (using "ctags" and "cproto"); this index lists
|
||||
all files used, all functions defined, and all TODOs marked in the code.
|
||||
|
||||
|
||||
Author and acknowledgements
|
||||
***************************
|
||||
|
||||
This package is copyright 2021 Andrew Wood, and is being distributed under
|
||||
the terms of the Artistic License 2.0. For more details of this license,
|
||||
see the file `doc/COPYING'.
|
||||
|
||||
Report bugs in `pv' using the contact form linked from the home page.
|
||||
|
||||
The `pv' home page is at:
|
||||
|
||||
http://www.ivarch.com/programs/pv.shtml
|
||||
|
||||
The latest version can always be found here.
|
||||
|
||||
Credit is also due to:
|
||||
|
||||
Jakub Hrozek <jhrozek@redhat.com>
|
||||
- Fedora package maintainer
|
||||
|
||||
Antoine Beaupré <anarcat@debian.org>
|
||||
- Debian package maintainer
|
||||
|
||||
Kevin Coyner <kcoyner@debian.org>
|
||||
Cédric Delfosse <cedric@debian.org>
|
||||
- previous Debian package maintainers
|
||||
|
||||
Eduardo Aguiar <eduardo.oliveira@sondabrasil.com.br>
|
||||
- provided Portuguese (Brazilian) translation
|
||||
|
||||
Stéphane Lacasse <stephane@gorfou.ca>
|
||||
- provided French translation
|
||||
|
||||
Marcos Kreinacke <public@kreinacke.com>
|
||||
- provided German translation
|
||||
|
||||
Bartosz Feński <fenio@o2.pl> <http://skawina.eu.org/>
|
||||
- provided Polish translation along with Krystian Zubel
|
||||
|
||||
Joshua Jensen
|
||||
- reported RPM installation bug
|
||||
|
||||
Boris Folgmann <http://www.folgmann.com/en/>
|
||||
- reported cursor handling bug
|
||||
|
||||
Mathias Gumz
|
||||
- reported NLS bug
|
||||
|
||||
Daniel Roethlisberger
|
||||
- submitted patch to use lockfiles for -c if terminal locking fails
|
||||
|
||||
Adam Buchbinder
|
||||
- lots of help with a Cygwin port of -c
|
||||
|
||||
Mark Tomich <http://metuchen.dyndns.org>
|
||||
- suggested -B option
|
||||
|
||||
Gert Menke
|
||||
- reported bug when piping to dd with a large input buffer size
|
||||
|
||||
Ville Herva <Ville.Herva@iki.fi>
|
||||
- informative bug report about rate limiting performance
|
||||
|
||||
Elias Pipping
|
||||
- patch to compile properly on Darwin 9; potential NULL deref report
|
||||
|
||||
Patrick Collison
|
||||
- similar patch for OS X
|
||||
|
||||
Boris Lohner
|
||||
- reported problem that "-L" does not complain if given non-numeric value
|
||||
|
||||
Sebastian Kayser
|
||||
- supplied testing for SIGPIPE, demonstrated internationalisation problem
|
||||
|
||||
Laszlo Ersek <http://phptest11.atw.hu/>
|
||||
- reported shared memory leak on SIGINT with -c
|
||||
|
||||
Phil Rutschman <http://bandgap.rsnsoft.com/>
|
||||
- provided a patch for fully restoring terminal state on exit
|
||||
|
||||
Henry Precheur <http://henry.precheur.org/>
|
||||
- reporting and suggestions for --rate-limit bug when rate is under 10
|
||||
|
||||
E. Rosten <http://mi.eng.cam.ac.uk/~er258/>
|
||||
- supplied patch for block buffering in line mode
|
||||
|
||||
Kjetil Torgrim Homme
|
||||
- reported compilation error with default CFLAGS on non-GCC compilers
|
||||
|
||||
Alexandre de Verteuil
|
||||
- reported bug in OS X build and supplied test environment to fix in
|
||||
|
||||
Martin Baum
|
||||
- supplied patch to return nonzero exit status if terminated by signal
|
||||
|
||||
Sam Nelson <http://www.siliconfuture.net/>
|
||||
- supplied patch to fix trailing slash on DESTDIR
|
||||
|
||||
Daniel Pape
|
||||
- reported Cygwin installation problem due to DESTDIR
|
||||
|
||||
Philipp Beckers
|
||||
- ported to the Syabas PopcornHour A-100 series
|
||||
|
||||
Henry Gebhard <hsggebhardt@googlemail.com>
|
||||
- supplied patches to improve SI prefixes and add --average-rate
|
||||
|
||||
Vladimir Kokarev, Alexander Leo
|
||||
- reported that exit status did not reflect file errors
|
||||
|
||||
Thomas Rachel
|
||||
- submitted patches for IEEE1541 (MiB suffixes), 1+e03 bug
|
||||
|
||||
Guillaume Marcais
|
||||
- submitted speedup patch for line mode
|
||||
|
||||
Moritz Barsnick
|
||||
- submitted patch for compile warning in size calculation
|
||||
|
||||
Pawel Piatek
|
||||
- submitted RPM and patches for AIX
|
||||
|
||||
Sami Liedes
|
||||
- submitted patch for --timer and --bytes with --numeric
|
||||
|
||||
Steven Willis
|
||||
- reported problem with "-R" killing non-PV remote processes
|
||||
|
||||
Vladimir Pal, Vladimir Ermakov
|
||||
- submitted patch which led to development of --format option
|
||||
|
||||
Peter Samuelson <peter@p12n.org>
|
||||
- submitted patch to calculate size if stdout is a block device
|
||||
|
||||
Miguel Diaz
|
||||
- much Cygwin help (and packaging), found narrow-terminal bug
|
||||
|
||||
Jim Salter <http://ubuntuwiki.net>
|
||||
- commissioned work on the --skip-errors option
|
||||
|
||||
Wouter Pronk
|
||||
- reported build problem on SCO
|
||||
|
||||
Bryan Dongray <http://www.dongrays.com>
|
||||
- provided patches for test scripts failing on older Red Hats
|
||||
|
||||
Zev Weiss <www.bewilderbeest.net>
|
||||
- provided patch to fix splice() not using stdin
|
||||
|
||||
Zing Shishak
|
||||
- provided patch for --null / -0 (count null terminated lines)
|
||||
|
||||
Jacek Wielemborek <http://deetah.jogger.pl/kategorie/english>
|
||||
- implemented fdwatch in Python, suggested PV port
|
||||
- reported bug with "-l" and ETA / size
|
||||
- suggested common switches
|
||||
|
||||
Kim Krecht
|
||||
- suggested buffer fill status and last bytes output display options
|
||||
|
||||
Cristian Ciupitu <http://ciupicri.github.io>, Josh Stone
|
||||
- pointed out file descriptor leak with helpful suggestions
|
||||
(Josh Stone initially noticed the missing close)
|
||||
|
||||
Jan Seda
|
||||
- found issue with splice() and SPLICE_F_NONBLOCK causing slowdown
|
||||
|
||||
André Stapf
|
||||
- pointed out formatting problem e.g. 13GB -> 13.1GB which should be
|
||||
shown 13.0GB -> 13.1GB; highlighted on-startup row swapping in -c
|
||||
|
||||
Damon Harper <http://www.usrbin.ca/>
|
||||
- suggested "-D" / "--delay-start" option
|
||||
|
||||
Ganaël Laplanche <http://www.martymac.org>
|
||||
- provided patch for lstat64 on systems that do not support it
|
||||
|
||||
Peter Korsgaard <http://www.buildroot.net/>
|
||||
- provided similar patch for lstat64, specifically for uClibc support
|
||||
- provided AIX cross-compilation patch to fix bug in -lc128 check
|
||||
|
||||
Ralf Ramsauer <https://blog.ramses-pyramidenbau.de/>
|
||||
- reported bug which dropped transfer rate on terminal resize
|
||||
|
||||
Michiel Van Herwegen
|
||||
- reported and discussed bug with "-l" and ETA / size
|
||||
|
||||
Erkki Seppälä <http://www.inside.org/~flux/>
|
||||
- provided patch implementing "-I"
|
||||
|
||||
Eric A. Borisch
|
||||
- provided details of compatibility fix for "%Lu" in watchpid code
|
||||
|
||||
Jan Venekamp
|
||||
- reported MacOS buffer size interactions with pipes
|
||||
|
||||
Matt <https://github.com/lemonsqueeze/pv>
|
||||
- provided "rate-window" patches for rate calculation
|
||||
|
||||
Filippo Valsorda
|
||||
- provided patch for stat64 issue on Apple Silicon
|
||||
|
||||
Matt Koscica, William Dillon
|
||||
- also reported stat64 issue on Apple Silicon
|
||||
|
||||
Norman Rasmussen
|
||||
- suggested -c with -d PID:FD, reject -N with -d PID
|
||||
|
||||
Andriy Gapon, Jonathan Elchison
|
||||
- reported bug where "pv /dev/zero >/dev/null &" stops immediately
|
||||
|
||||
Marcelo Chiesa
|
||||
- reported unused-result warnings when compiling PV 1.6.6
|
||||
|
||||
Jered Floyd
|
||||
- provided patches to improve --rate-limit
|
||||
|
||||
Christoph Biedl
|
||||
- provided ETA and dynamic interval patches
|
||||
|
||||
Richard Fonfara
|
||||
- provided German translations for "pv --help"
|
||||
|
||||
Johannes Gerer <http://johannesgerer.com>
|
||||
- suggested that "-B" should enable "-C"
|
||||
|
||||
Sam James
|
||||
- provided fix for number.c build issue caused by missing stddef.h
|
||||
|
||||
Jakub Wilk <jwilk@jwilk.net>
|
||||
- corrected README encoding
|
||||
|
||||
-----------------------------------------------------------------------------
|
||||
@@ -0,0 +1,56 @@
|
||||
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.
|
||||
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
|
||||
A manual page is included in this distribution. See "`man ./doc/quickref.1`",
|
||||
or "`man pv`" after installation.
|
||||
|
||||
|
||||
Compilation
|
||||
-----------
|
||||
|
||||
If this is not a packaged release, first run "`./generate.sh`".
|
||||
|
||||
To compile the package, type "`sh ./configure`", which should generate a
|
||||
Makefile for your system. You may then type "`make`" to build everything.
|
||||
Note that GNU _make_ is required; this may be installed as _gmake_ on some
|
||||
systems, so if typing "`make`" gives an error, try "`gmake`" instead.
|
||||
|
||||
See the file "doc/INSTALL" for more about the _configure_ script.
|
||||
|
||||
Developers note that you can run "`./configure --enable-debugging`" to cause
|
||||
debugging support to be built in, and the `--enable-profiling` option builds
|
||||
in profiling support (see "`man gprof`"). Also note that running
|
||||
"`make index`" will generate an HTML code index (using _ctags_ and
|
||||
_cproto_); this index lists all files used, all functions defined, and all
|
||||
TODOs marked in the code.
|
||||
|
||||
|
||||
Author and acknowledgements
|
||||
---------------------------
|
||||
|
||||
This package is copyright 2022 Andrew Wood, and is being distributed under
|
||||
the terms of the Artistic License 2.0. For more details of this license,
|
||||
see the file "doc/COPYING".
|
||||
|
||||
Report bugs in **pv** using the contact form linked from the home page, or
|
||||
though the [project issue tracker](https://github.com/a-j-wood/pv/issues).
|
||||
|
||||
The `pv' home page is at:
|
||||
|
||||
http://www.ivarch.com/programs/pv.shtml
|
||||
|
||||
The latest version can always be found here.
|
||||
|
||||
**Please see "[doc/ACKNOWLEDGEMENTS.md](./doc/ACKNOWLEDGEMENTS.md)" for a list of contributors.**
|
||||
|
||||
---
|
||||
@@ -7,7 +7,7 @@ version = @VERSION@
|
||||
PACKAGE = @PACKAGE@
|
||||
|
||||
distfiles = \
|
||||
$(srcdir)/README \
|
||||
$(srcdir)/README.md \
|
||||
$(srcdir)/autoconf \
|
||||
$(srcdir)/configure \
|
||||
$(srcdir)/doc \
|
||||
|
||||
@@ -0,0 +1,76 @@
|
||||
The following people have contributed to this project, and their assistance
|
||||
is acknowledged and greatly appreciated:
|
||||
|
||||
* Jakub Hrozek <jhrozek@redhat.com> - Fedora package maintainer
|
||||
* Antoine Beaupré <anarcat@debian.org> - Debian package maintainer
|
||||
* Kevin Coyner <kcoyner@debian.org> - previous Debian package maintainer
|
||||
* Cédric Delfosse <cedric@debian.org> - previous Debian package maintainer
|
||||
* Eduardo Aguiar <eduardo.oliveira@sondabrasil.com.br> - provided Portuguese (Brazilian) translation
|
||||
* Stéphane Lacasse <stephane@gorfou.ca> - provided French translation
|
||||
* Marcos Kreinacke <public@kreinacke.com> - provided German translation
|
||||
* Bartosz Feński <fenio@o2.pl> <http://skawina.eu.org/> - provided Polish translation along with Krystian Zubel
|
||||
* Joshua Jensen - reported RPM installation bug
|
||||
* Boris Folgmann <http://www.folgmann.com/en/> - reported cursor handling bug
|
||||
* Mathias Gumz - reported NLS bug
|
||||
* Daniel Roethlisberger - submitted patch to use lockfiles for -c if terminal locking fails
|
||||
* Adam Buchbinder - lots of help with a Cygwin port of -c
|
||||
* Mark Tomich <http://metuchen.dyndns.org> - suggested -B option
|
||||
* Gert Menke - reported bug when piping to dd with a large input buffer size
|
||||
* Ville Herva <Ville.Herva@iki.fi> - informative bug report about rate limiting performance
|
||||
* Elias Pipping - patch to compile properly on Darwin 9; potential NULL deref report
|
||||
* Patrick Collison - similar patch for OS X
|
||||
* Boris Lohner - reported problem that "-L" does not complain if given non-numeric value
|
||||
* Sebastian Kayser - supplied testing for SIGPIPE, demonstrated internationalisation problem
|
||||
* Laszlo Ersek <http://phptest11.atw.hu/> - reported shared memory leak on SIGINT with -c
|
||||
* Phil Rutschman <http://bandgap.rsnsoft.com/> - provided a patch for fully restoring terminal state on exit
|
||||
* Henry Precheur <http://henry.precheur.org/> - reporting and suggestions for --rate-limit bug when rate is under 10
|
||||
* E. Rosten <http://mi.eng.cam.ac.uk/~er258/> - supplied patch for block buffering in line mode
|
||||
* Kjetil Torgrim Homme - reported compilation error with default CFLAGS on non-GCC compilers
|
||||
* Alexandre de Verteuil - reported bug in OS X build and supplied test environment to fix in
|
||||
* Martin Baum - supplied patch to return nonzero exit status if terminated by signal
|
||||
* Sam Nelson <http://www.siliconfuture.net/> - supplied patch to fix trailing slash on DESTDIR
|
||||
* Daniel Pape - reported Cygwin installation problem due to DESTDIR
|
||||
* Philipp Beckers - ported to the Syabas PopcornHour A-100 series
|
||||
* Henry Gebhard <hsggebhardt@googlemail.com> - supplied patches to improve SI prefixes and add --average-rate
|
||||
* Vladimir Kokarev, Alexander Leo - reported that exit status did not reflect file errors
|
||||
* Thomas Rachel - submitted patches for IEEE1541 (MiB suffixes), 1+e03 bug
|
||||
* Guillaume Marcais - submitted speedup patch for line mode
|
||||
* Moritz Barsnick - submitted patch for compile warning in size calculation
|
||||
* Pawel Piatek - submitted RPM and patches for AIX
|
||||
* Sami Liedes - submitted patch for --timer and --bytes with --numeric
|
||||
* Steven Willis - reported problem with "-R" killing non-PV remote processes
|
||||
* Vladimir Pal, Vladimir Ermakov - submitted patch which led to development of --format option
|
||||
* Peter Samuelson <peter@p12n.org> - submitted patch to calculate size if stdout is a block device
|
||||
* Miguel Diaz - much Cygwin help (and packaging), found narrow-terminal bug
|
||||
* Jim Salter <http://ubuntuwiki.net> - commissioned work on the --skip-errors option
|
||||
* Wouter Pronk - reported build problem on SCO
|
||||
* Bryan Dongray <http://www.dongrays.com> - provided patches for test scripts failing on older Red Hats
|
||||
* Zev Weiss <www.bewilderbeest.net> - provided patch to fix splice() not using stdin
|
||||
* Zing Shishak - provided patch for --null / -0 (count null terminated lines)
|
||||
* Jacek Wielemborek <http://deetah.jogger.pl/kategorie/english> - implemented fdwatch in Python, suggested PV port; reported bug with "-l" and ETA / size; many other contributions
|
||||
* Kim Krecht - suggested buffer fill status and last bytes output display options
|
||||
* Cristian Ciupitu <http://ciupicri.github.io>, Josh Stone - pointed out file descriptor leak with helpful suggestions (Josh Stone initially noticed the missing close)
|
||||
* Jan Seda - found issue with splice() and SPLICE_F_NONBLOCK causing slowdown
|
||||
* André Stapf - pointed out formatting problem e.g. 13GB -> 13.1GB which should be shown 13.0GB -> 13.1GB; highlighted on-startup row swapping in -c
|
||||
* Damon Harper <http://www.usrbin.ca/> - suggested "-D" / "--delay-start" option
|
||||
* Ganaël Laplanche <http://www.martymac.org> - provided patch for lstat64 on systems that do not support it
|
||||
* Peter Korsgaard <http://www.buildroot.net/> - provided similar patch for lstat64, specifically for uClibc support; provided AIX cross-compilation patch to fix bug in -lc128 check
|
||||
* Ralf Ramsauer <https://blog.ramses-pyramidenbau.de/> - reported bug which dropped transfer rate on terminal resize
|
||||
* Michiel Van Herwegen - reported and discussed bug with "-l" and ETA / size
|
||||
* Erkki Seppälä <http://www.inside.org/~flux/> - provided patch implementing "-I"
|
||||
* Eric A. Borisch - provided details of compatibility fix for "%Lu" in watchpid code
|
||||
* Jan Venekamp - reported MacOS buffer size interactions with pipes
|
||||
* Matt <https://github.com/lemonsqueeze/pv> - provided "rate-window" patches for rate calculation
|
||||
* Filippo Valsorda - provided patch for stat64 issue on Apple Silicon
|
||||
* Matt Koscica, William Dillon - also reported stat64 issue on Apple Silicon
|
||||
* Norman Rasmussen - suggested -c with -d PID:FD, reject -N with -d PID
|
||||
* Andriy Gapon, Jonathan Elchison - reported bug where "pv /dev/zero >/dev/null &" stops immediately
|
||||
* Marcelo Chiesa - reported unused-result warnings when compiling PV 1.6.6
|
||||
* Jered Floyd - provided patches to improve --rate-limit
|
||||
* Christoph Biedl - provided ETA and dynamic interval patches
|
||||
* Richard Fonfara - provided German translations for "pv --help"
|
||||
* Johannes Gerer <http://johannesgerer.com> - suggested that "-B" should enable "-C"
|
||||
* Sam James - provided fix for number.c build issue caused by missing stddef.h
|
||||
* Jakub Wilk <jwilk@jwilk.net> - corrected README encoding
|
||||
|
||||
---
|
||||
@@ -1,3 +1,8 @@
|
||||
UNRELEASED
|
||||
- docs: moved all open issues into GitHub and updated the TODO list
|
||||
- docs: renamed README to README.md and altered it to Markdown format
|
||||
- docs: moved contributors from the README to docs/ACKNOWLEDGEMENTS.md
|
||||
|
||||
1.6.20 - 12 September 2021
|
||||
- fix: add missing stddef.h include to number.c (Sam James)
|
||||
|
||||
|
||||
+2
-1
@@ -565,7 +565,8 @@ A zero exit status indicates no problems.
|
||||
|
||||
.SH AUTHOR
|
||||
Written by Andrew Wood, with patches submitted by various other people.
|
||||
Please see the package README for a complete list of contributors.
|
||||
Please see the package's ACKNOWLEDGEMENTS file for a complete list of
|
||||
contributors.
|
||||
|
||||
|
||||
.SH KNOWN PROBLEMS
|
||||
|
||||
+1
-1
@@ -43,7 +43,7 @@ make test
|
||||
%{_bindir}/%{name}
|
||||
%{_mandir}/man1/%{name}.1.gz
|
||||
|
||||
%doc README doc/NEWS doc/TODO doc/COPYING
|
||||
%doc README.md doc/ACKNOWLEDGEMENTS.md doc/NEWS doc/TODO doc/COPYING
|
||||
|
||||
%changelog
|
||||
* Sun Sep 12 2021 Andrew Wood <andrew.wood@ivarch.com> 1.6.20-1
|
||||
|
||||
Reference in New Issue
Block a user