This is doc/pv.info, produced by makeinfo version 4.7 from doc/manual.texi. INFO-DIR-SECTION Miscellaneous START-INFO-DIR-ENTRY * PV: (pv). Monitor the progress of data through a pipe. END-INFO-DIR-ENTRY This file documents the "pv" package, version 0.9.6. Copyright 2005 Andrew Wood Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are preserved on all copies. Permission is granted to copy and distribute modified versions of this manual under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one. Permission is granted to copy and distribute translations of this manual into another language, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by Andrew Wood.  File: pv.info, Node: Top, Next: Overview, Up: (dir) Pipe Viewer *********** This edition of the `PV manual', last updated 29 June 2004, documents `pv' version 0.9.6. * Menu: * Overview:: Overview of `pv'. * Invocation:: Invoking `pv'. * Concept Index:: Index of concepts. --- The Detailed Node Listing --- * Display switches:: Options to change which information is shown. * Output modifiers:: Options altering the way this information is given. * General options:: Everything that's left over.  File: pv.info, Node: Overview, Next: Invocation, Prev: Top, Up: Top 1 Overview ********** This is the documentation for `pv', 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.  File: pv.info, Node: Invocation, Next: Display switches, Prev: Overview, Up: Top 2 Invocation ************ Summary: `pv [OPTION] [FILE]...' To use `pv', insert it in a pipeline between two processes, with the appropriate options. Its standard input will be passed through to its standard output and progress will be shown on standard error. `pv' will copy each supplied FILE in turn to standard output (`-' means standard input), or if no FILEs are specified just standard input is copied. This is the same behaviour as `cat'. A simple example to watch how quickly a file is transferred using `nc': pv file | nc -w 1 somewhere.com 3000 A similar example, transferring a file from another process and passing the expected size to `pv': cat file | pv -s 12345 | nc -w 1 somewhere.com 3000 A more complicated example using numeric output to feed into the `dialog' program for a full-screen progress display: (tar cf - . \ | pv -n -s `du -sb . | awk '{print $1}'` \ | gzip -9 > out.tgz) 2>&1 \ | dialog --gauge 'Progress' 7 70 Frequent use of this third form is not recommended as it may cause the programmer to overheat. `pv' takes many options, which are divided into display switches, output modifiers, and general options. * Menu: * Display switches:: Options to change which information is shown. * Output modifiers:: Options altering the way this information is given. * General options:: Everything that's left over.  File: pv.info, Node: Display switches, Next: Output modifiers, Prev: Invocation, Up: Invocation 2.1 Display switches ==================== If no display switches are specified, `pv' behaves as if `-p', `-t', `-e', `-r', and `-b' had been given (i.e. everything is switched on). Otherwise, only those display types that are explicitly switched on will be shown. `-p' `--progress' Turn the progress bar on. If standard input is not a file and no size was given (with the `-s' modifier), the progress bar cannot indicate how close to completion the transfer is, so it will just move left and right to indicate that data is moving. `-t' `--timer' Turn the timer on. This will display the total elapsed time that `pv' has been running for. `-e' `--eta' Turn the ETA timer on. This will attempt to guess, based on previous transfer rates and the total data size, how long it will be before completion. This option will have no effect if the total data size cannot be determined. `-r' `--rate' Turn the rate counter on. This will display the current rate of data transfer. `-b' `--bytes' Turn the total byte counter on. This will display the total amount of data transferred so far. `-n' `--numeric' Numeric output. Instead of giving a visual indication of progress, `pv' will give an integer percentage, one per line, on standard error, suitable for piping (via convoluted redirection) into the `dialog' program. Note that `-f' is not required if `-n' is being used. `-q' `--quiet' No output. Useful if the `-L' option is being used on its own to just limit the transfer rate of a pipe.  File: pv.info, Node: Output modifiers, Next: General options, Prev: Display switches, Up: Invocation 2.2 Output modifiers ==================== `-L RATE' `--rate-limit RATE' Limit the transfer to a maximum of RATE bytes per second. A suffix of "k", "m", "g", or "t" can be added to denote kilobytes (*1024), megabytes, and so on. `-W' `--wait' Wait until the first byte has been transferred before showing any progress information or calculating any ETAs. Useful if the program you are piping to or from requires extra information before it starts, eg piping data into `gpg' or `mcrypt' which require a passphrase before data can be processed. `-s SIZE' `--size SIZE' Assume the total amount of data to be transferred is SIZE bytes when calculating percentages and ETAs. The same suffixes of "k", "m" etc can be used as with `-L'. `-i SEC' `--interval SEC' Wait SEC seconds between updates. The default is to update every second. Note that this can be a decimal such as 0.1. `-w WIDTH' `--width WIDTH' Assume the terminal is WIDTH characters wide, instead of trying to work it out (or assuming 80 if it cannot be guessed). `-H HEIGHT' `--height HEIGHT' Assume the terminal is HEIGHT rows high, instead of trying to work it out (or assuming 25 if it cannot be guessed). `-N NAME' `--name NAME' Prefix the output information with NAME. Useful in conjunction with `-c' if you have a complicated pipeline and you want to be able to tell different parts of it apart. `-f' `--force' Force output. Normally, `pv' will not output any visual display if standard error is not a terminal. This option forces it to do so. `-c' `--cursor' Use cursor positioning escape sequences instead of just using carriage returns. This is useful in conjunction with `-N' (name) if you are using multiple `pv' invocations in a single, long, pipeline.  File: pv.info, Node: General options, Prev: Output modifiers, Up: Invocation 2.3 General options =================== `-h' `--help' Print a usage message on standard output and exit successfully. `-l' `--license' Print details of the program's license on standard output and exit successfully. `-V' `--version' Print version information on standard output and exit successfully.  File: pv.info, Node: Concept Index, Up: Top Concept Index ************* [index] * Menu: * Bytes transferred: Display switches. (line 35) * Completion time: Display switches. (line 23) * Cursor positioning: Output modifiers. (line 53) * Data size: Output modifiers. (line 20) * Dialog, output to: Display switches. (line 40) * Elapsed time: Display switches. (line 18) * ETA: Display switches. (line 23) * Example, using dialog: Invocation. (line 29) * Example, using nc: Invocation. (line 19) * Force terminal output: Output modifiers. (line 47) * Height: Output modifiers. (line 36) * Interval: Output modifiers. (line 26) * Limiting transfer rate: Output modifiers. (line 6) * Name: Output modifiers. (line 41) * No output: Display switches. (line 48) * Numeric output: Display switches. (line 40) * Output height: Output modifiers. (line 36) * Output width: Output modifiers. (line 31) * Percentage only output: Display switches. (line 40) * Prefix: Output modifiers. (line 41) * Progress bar: Display switches. (line 11) * Quiet (no output): Display switches. (line 48) * Rate: Display switches. (line 30) * Rate limiting: Output modifiers. (line 6) * Silent (no output): Display switches. (line 48) * Size: Output modifiers. (line 20) * Terminal columns: Output modifiers. (line 31) * Terminal height: Output modifiers. (line 36) * Terminal rows: Output modifiers. (line 36) * Terminal width: Output modifiers. (line 31) * Time, elapsed: Display switches. (line 18) * Time, until completion: Display switches. (line 23) * Timer: Display switches. (line 18) * Transfer rate: Display switches. (line 30) * Update interval: Output modifiers. (line 26) * Wait: Output modifiers. (line 12) * Wait until transfer starts: Output modifiers. (line 12) * Width: Output modifiers. (line 31)  Tag Table: Node: Top963 Node: Overview1502 Node: Invocation1960 Node: Display switches3463 Node: Output modifiers5174 Node: General options7159 Node: Concept Index7568  End Tag Table