mkb

progress bar maker
git clone git://git.2f30.org/mkb.git
Log | Files | Refs

mkb.1 (1385B)


      1 .Dd $Mdocdate: November 15 2015 $ 
      2 .Dt MKB section 
      3 .Os 
      4 .Sh NAME 
      5 .Nm mkb 
      6 .Nd Draws a progress bar based on the input level
      7 .Sh SYNOPSIS 
      8 .Nm mkb 
      9 .Ar [perc]
     10 .Sh DESCRIPTION 
     11 The 
     12 .Nm 
     13 utility draws a progress bar based on the input level given as argument or
     14 from stdin in stylized way that can be changed via the environment.
     15 .Bl -tag -width Ds
     16 .It perc
     17 A percentage value to be represented as a progress bar. If this argument isn't provided,
     18 .Nm
     19 will attempt to read values from stdin.
     20 .El
     21 .Sh ENVIRONMENT 
     22 .Bl -tag -width Ds
     23 .It Ev SIZE
     24 The number of characters used to represent the bar. (default: 32)
     25 .It Ev CHAR1
     26 The string used to represent the left part. (default: '━')
     27 .It Ev CHAR2
     28 The string used to represent the right part. (default: '━')
     29 .It Ev SEP
     30 The string used to represent the separator. (default: '╋^[[1;30m')
     31 .It Ev START
     32 The string printed at the beginning of the bar. (default: '^[[1;37m')
     33 .It Ev END
     34 The string printed at the end of the bar. (default: '^[[0m')
     35 .Sh EXAMPLES 
     36 .Dl $ mkb 75
     37 .Dl ━━━━━━━━━━━━━━━━━━━━━━━━╋━━━━━━━
     38 .Pp
     39 .Dl $ echo 64 | SIZE=10 mkb
     40 .Dl ━━━━━━━╋━━
     41 .Pp
     42 .Dl $ CHAR1='+' CHAR2='-' SEP='>' mkb 32
     43 .Dl +++++++++++>--------------------
     44 .Sh SEE ALSO 
     45 .Xr environ 7
     46 .Sh AUTHORS 
     47 Willy 'z3bra' Goiffon <willyatmailoodotorg>
     48 .Sh BUGS 
     49 Please report them.