summaryrefslogtreecommitdiff
path: root/system/bar/README
diff options
context:
space:
mode:
Diffstat (limited to 'system/bar/README')
-rw-r--r--system/bar/README9
1 files changed, 9 insertions, 0 deletions
diff --git a/system/bar/README b/system/bar/README
new file mode 100644
index 0000000000..c5a4500cf2
--- /dev/null
+++ b/system/bar/README
@@ -0,0 +1,9 @@
+Command Line Progress Bar - show information about a data transfer.
+
+Bar is a simple tool to copy a stream of data and print a display for the
+user on stderr showing (a) the amount of data passed, (b) the throughput
+of the data transfer, and (c) the transfer time.
+
+Or, if the total size of the data stream is known: the estimated time
+remaining, what percentage of the data transfer has been completed, and
+a progress bar.