add man page

bcalc.1

@@ -0,0 +1,229 @@
+.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings.  \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+.    ds -- \(*W-
+.    ds PI pi
+.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
+.    ds L" ""
+.    ds R" ""
+.    ds C` ""
+.    ds C' ""
+'br\}
+.el\{\
+.    ds -- \|\(em\|
+.    ds PI \(*p
+.    ds L" ``
+.    ds R" ''
+.    ds C`
+.    ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{
+.    if \nF \{
+.        de IX
+.        tm Index:\\$1\t\\n%\t"\\$2"
+..
+.        if !\nF==2 \{
+.            nr % 0
+.            nr F 2
+.        \}
+.    \}
+.\}
+.rr rF
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.    \" fudge factors for nroff and troff
+.if n \{\
+.    ds #H 0
+.    ds #V .8m
+.    ds #F .3m
+.    ds #[ \f1
+.    ds #] \fP
+.\}
+.if t \{\
+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.    ds #V .6m
+.    ds #F 0
+.    ds #[ \&
+.    ds #] \&
+.\}
+.    \" simple accents for nroff and troff
+.if n \{\
+.    ds ' \&
+.    ds ` \&
+.    ds ^ \&
+.    ds , \&
+.    ds ~ ~
+.    ds /
+.\}
+.if t \{\
+.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+.    \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+.    \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+.    \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+.    ds : e
+.    ds 8 ss
+.    ds o a
+.    ds d- d\h'-1'\(ga
+.    ds D- D\h'-1'\(hy
+.    ds th \o'bp'
+.    ds Th \o'LP'
+.    ds ae ae
+.    ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "BCALC 1"
+.TH BCALC 1 "2018-03-31" "perl v5.22.1" "User Contributed Perl Documentation"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+bcalc \- Bitrate\-speed\-size calculator
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+bcalc [options] \s-1SIZE SIZE_UNIT\s0 @ \s-1SPEED SPEED_UNIT\s0
+.PP
+or
+.PP
+bcalc [options] \s-1DURATION DURATION_UNIT\s0 @ \s-1SPEED SPEED_UNIT\s0
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+Calculate the time it takes to transfer files of a given size at a given speed.
+Or calculates the resulting size for a given duration and bitrate.
+.PP
+The spaces between arguments are optional.
+.SH "SIZE UNITS"
+.IX Header "SIZE UNITS"
+In size units, an uppercase B means Bytes (8 bits). A lowercase b means bits.
+The size can be prefixed with a one-letter or full unit name. The following
+are valid size units:
+.PP
+.Vb 5
+\&  b or bits
+\&  B or Bytes
+\&  kb or kilobits
+\&  kB or kilobytes
+\&  etc. with Mb, MB, Gb, GB, Tb, TB
+.Ve
+.PP
+The greatest recognize size unit is TeraBytes. That should be enough for a couple
+of years...
+.SH "SPEED UNITS"
+.IX Header "SPEED UNITS"
+Speed units are the same as size untis, suffixed with \*(L"ps\*(R" (per second). For example:
+.PP
+.Vb 1
+\&  bps, Mbps, MBps Megabytesps, ...
+.Ve
+.SH "DURATION UNITS"
+.IX Header "DURATION UNITS"
+Valid duration units are:
+.PP
+.Vb 3
+\&  s or sec or seconds
+\&  m or mn or minutes
+\&  h or hours
+.Ve
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+.IP "\fB\-?\fR or \fB\-h\fR" 8
+.IX Item "-? or -h"
+Print a brief help message and exit.
+.IP "\fB\-\-help\fR" 8
+.IX Item "--help"
+Print the manual page and exit.
+.IP "\fB\-v\fR or \fB\-\-verbose\fR" 8
+.IX Item "-v or --verbose"
+Print details of conversions done
+.IP "\fB\-d\fR or \fB\-\-debug\fR" 8
+.IX Item "-d or --debug"
+Print even more details of argument analysis and conversions
+.SH "EXAMPLES"
+.IX Header "EXAMPLES"
+The following all print out the same result:
+.PP
+.Vb 6
+\&  bcalc 7 GB @ 90 KBps
+\&  bcalc 7GB@90KBps
+\&  bcalc 7 Giga bytes @ 90Kilobytesps
+\&  bcalc 7 Giga bytes @ 90Kilobytespersecond
+\&  bcalc 7 Giga bytes @ 90 Kilobytes per second
+\&  bcalc 7 G bytes @ 90 Kilobytes per second
+\&
+\&  = 21.60 hours
+.Ve
+.PP
+Or calculate size from duration:
+.PP
+.Vb 1
+\&  bcalc 1mn @ 120Mbps
+\&
+\&  bcalc 1h  @ 120Mbps
+.Ve
+.ie n .SH "CHANGES 0.32 : clearer warning if speed_unit not found 0.3 : accept ""pm"" for ""per minute"" as in 6GBpm"
+.el .SH "CHANGES 0.32 : clearer warning if speed_unit not found 0.3 : accept ``pm'' for ``per minute'' as in 6GBpm"
+.IX Header "CHANGES 0.32 : clearer warning if speed_unit not found 0.3 : accept pm for per minute as in 6GBpm"
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+mi dot deb at alma dot ch, 2010\-2013,2018