2020-04-03 12:56:13 (UTC-03:00)
Marcel Rodrigues <marcelgmr@gmail.com>
minor improvements to documentation
diff --git a/README b/README index c813b8a..bd689f5 100644 --- a/README +++ b/README @@ -9,7 +9,7 @@ SSYYNNOOPPSSIISS mmppbb [--oo] [--vv] [--ss] [--ww_W_I_D_T_H] [_T_O_T_A_L] DDEESSCCRRIIPPTTIIOONN - Show progress of lines read from _s_t_d_i_n. + Show progress of lines read from _s_t_d_i_n in _s_t_d_e_r_r. OOPPTTIIOONNSS --oo output _s_t_d_i_n to _s_t_d_o_u_t @@ -22,15 +22,15 @@ OOPPTTIIOONNSS set width of progress bar (default = 32) _T_O_T_A_L number of lines expected to be read until completion of task - if _T_O_T_A_L is not given or it's zero, the progress bar will not be - shown + if _T_O_T_A_L is not given or it is zero, the progress bar will not + be shown EEXXAAMMPPLLEESS Use sseeqq((11)) to test drive mmppbb: - $ n=5000; seq 1 $n | mpb -vsw50 $n + $ n=5000; seq 1 $n | mpb -vsw50 $n Show progress of ttaarr((11)) extraction: - $ f=foo.tgz; n=$(tar tf $f | wc -l); tar vxf $f | mpb -v $n + $ f=foo.tgz; n=$(tar tf $f | wc -l); tar vxf $f | mpb -v $n diff --git a/mpb.1 b/mpb.1 index fe4d12c..69c561d 100644 --- a/mpb.1 +++ b/mpb.1 @@ -5,7 +5,7 @@ mpb \- more progress bar .B mpb [\fB\-o\fR] [\fB\-v\fR] [\fB\-s\fR] [\fB\-w\fR\fIWIDTH\fR] [\fITOTAL\fR] .SH DESCRIPTION -Show progress of lines read from \fIstdin\fR. +Show progress of lines read from \fIstdin\fR in \fIstderr\fR. .SH OPTIONS .TP \fB\-o\fR @@ -23,18 +23,18 @@ set width of progress bar (default = 32) \fITOTAL\fR number of lines expected to be read until completion of task .br -if \fITOTAL\fR is not given or it's zero, the progress bar will not be shown +if \fITOTAL\fR is not given or it is zero, the progress bar will not be shown .SH EXAMPLES Use \fBseq(1)\fR to test drive \fBmpb\fR: .RS .nf - $ n=5000; seq 1 $n | mpb -vsw50 $n +$ n=5000; seq 1 $n | mpb -vsw50 $n .fi .RE .PP Show progress of \fBtar(1)\fR extraction: .RS .nf - $ f=foo.tgz; n=$(tar tf $f | wc -l); tar vxf $f | mpb -v $n +$ f=foo.tgz; n=$(tar tf $f | wc -l); tar vxf $f | mpb -v $n .fi .RE