File: pipemeter.1

package info (click to toggle)
pipemeter 1.1.3-1
  • links: PTS
  • area: main
  • in suites: bullseye, buster, jessie, jessie-kfreebsd, sid, stretch, wheezy
  • size: 352 kB
  • ctags: 67
  • sloc: ansic: 651; sh: 230; makefile: 46
file content (53 lines) | stat: -rw-r--r-- 2,965 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
.TH PIPEMETER 1
.SH NAME
pipemeter \- measure speed of data going through a pipe/redirection
.SH SYNOPSIS
.B pipemeter
[ -alV ] [ -s size ] [ -b block_size ] [ -m max_block_size ] [ -i interval ] [ -f infile -f infile2 ] infile infile2 ...
.SH DESCRIPTION
.I  pipemeter
simply takes input on stdin, and redirects it to its stdout. While doing this, it measures how fast the data is moving through it.
Alternatively, with the -s parameter, shows a progress bar as data is piped through it.
All output generated by pipemeter is written to stderr.

While running in progress mode, pipemeter will display the ETA (Estimated Time of Arrival). When exiting, it will change this field to show the elapsed time for the program. In rate-only mode, it will just show elapsed time.

Note that as of pipemeter 0.8, Adaptive Block Sizing is used to speed up the movement of data through it. It will increase, or sometimes decrease, the block size in an attempt to find the one that works best for the combination of input and output. This also helps it deal better with, for instance, a temporarily busy disk. You can use \fB\-a\fR to turn it off.
.TP
\fB\-s, \-\-size size\fR
Sets the size of the input, and turns on the progress bar.
.TP
\fB\-b, \-\-blocksize block_size\fR
Sets the size of blocks, in bytes, to move through the program at once. Default is 8192. A suffix of K means Kilobytes(x*1024) means Megabytes(x*1024*1024), and G means Gigabytes(x*1024*1024*1024).
.TP
\fB\-m, \-\-maxblock max_block_size\fR
Sets the maxium block size for adaptive block sizing. Default is 8M.
.TP
\fB\-i, \-\-interval interval\fR
Specify the number of seconds between updates on the speed and/or progress bar.
.TP
\fB\-f, \-\-file \fBinfile\fR
infile specifies a file to be read instead of stdin. It will also automatically turn on the progress bar if a size can be determined. Multiple occurances of -f will read the files in the order they are specified on the cmdline, and sizes will be added to eachother. Note that this option remains for backward compatibility, it is far simpler to just specify the input files without options.
.TP
\fB\-F, \-\-list \fBlistfile\fR
specifies a file to read in the list of input files from. Each line is a path to a file, terminated by a newline.
.TP
\fB\-r, \-\-report\fR
report only mode. This causes the program to suppress outputting/calculating while running. It will print out only one line.
.TP
\fB\-a, \-\-autooff\fR
turn off adaptive block sizing. Sometimes ABS can use insane amounts of RAM, such as when reading and writing to RAM disks.
.TP
\fB\-V, \-\-version\fR
Prints a version number and exits.
.TP
\fB\-l, \-\-log\fR
Turns on logging mode. Uses only newlines, no returns.
.SH AUTHOR
Written by Clint Byrum <cbyrum@spamaps.org>
.SH COPYRIGHT
Copyright \(co 2006 Clint Byrum
.br
This is free software; see the source for copying conditions.  There is
NO  warranty;  not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.