diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 165 |
1 files changed, 165 insertions, 0 deletions
@@ -0,0 +1,165 @@ +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 you have downloaded `pv' from Subversion, 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. + +Developers also note that the /* RATS */ comments are used to tell the RATS +tool that a potential trouble spot has been checked so it doesn't need to +warn about it. (RATS: Rough Auditing Tool for Security - home page +http://www.fortifysoftware.com/security-resources/rats.jsp) + + +Author +****** + +This package is copyright (C) 2012 Andrew Wood, and is being distributed +under the terms of the Artistic License 2.0. For more details, see the +file `doc/COPYING'. + +You can contact me by email at andrew.wood@ivarch.com or by using the +contact form on my web page at http://www.ivarch.com/. + +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: + + Kevin Coyner <kcoyner@debian.org> + - Debian package maintainer + + Jakub Hrozek <jhrozek@redhat.com> + - Fedora 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 + +----------------------------------------------------------------------------- |