Added installation and `-O3` in Makefile, created manpage and README and licensed under the MIT license

1 files changed, 51 insertions, 0 deletions

diff --git a/stdu.1 b/stdu.1
new file mode 100644
index 0000000..79fbcba
--- /dev/null
+++ b/stdu.1
@@ -0,0 +1,51 @@
+.Dd 2024-04-14
+.Dt STDU 1
+.Sh NAME
+.Nm stdu
+.Nd monitor amount of data read from stdin
+.Sh SYNOPSIS
+.Nm stdu
+.Op Fl Fl help
+.Op Fl Fl human-readable
+.Op Fl Fl multiline
+.Op Fl Fl precision Ar n
+.Nm stdu
+.Op Fl hm?
+.Op Fl p Ar n
+.Sh DESCRIPTION
+.Nm
+reads data from standard input and prints in real time the amount of data
+read.
+.Nm
+always prints the amount of data read as precisely as specified. Thus it
+has to read byte by byte (resulting to slow operation compared to reading
+in chunks) if \fB--precision\fR or \fB--human-readable\fR aren't specified,
+so specifying them is recommended.
+.Sh OPTIONS
+.Bl -tag -width 3n
+.It Fl Fl help | Fl ?
+Displays a help message.
+.It Fl Fl human-readable | Fl h
+Outputs in human-readable format. Uses binary prefixes by default
+(Ki, Mi, Gi, ...). SI prefixes (K, M, G, ...) are used instead if
+\fB--precision\fR is specified.
+.It Fl Fl multiline | Fl m
+Output with line breaks.
+.Nm
+outputs on one line by default.
+.It Fl Fl precision Ar n | Fl p Ar n | \fB-p\fIn\fR
+Output with
+.Ar n
+significant digits.
+.Nm
+may add trailing zeroes.
+.El
+.Sh EXAMPLES
+.Nm
+is useful as a progress bar replacement when transmitting large files.
+.Bd -literal
+nc -l 1234 | tee backup.tar.gz | stdu -p3 -h
+.Ed
+.Sh "SEE ALSO"
+.Xr du 1
+