summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorArun Prakash Jana <engineerarun@gmail.com>2019-12-10 23:12:42 +0530
committerArun Prakash Jana <engineerarun@gmail.com>2019-12-10 23:12:42 +0530
commita2b9998a2fe06885b3ea66b87de187cf3e6dbfcd (patch)
treed9baea272e5fbe9df85692d357a443a9f45a1f34
parentedd3dce0c8768afad8a682363a91138c79f63ba7 (diff)
Update docs
-rw-r--r--README.md2
-rw-r--r--bcal.18
2 files changed, 8 insertions, 2 deletions
diff --git a/README.md b/README.md
index 57fb0dc..f76094a 100644
--- a/README.md
+++ b/README.md
@@ -14,7 +14,7 @@
`bcal` (*Byte CALculator*) is a REPL CLI utility for storage expression evaluation, unit conversion and address calculation. If you can't calculate the hex address offset for (512 - 16) MiB, or the value when the 43<sup>rd</sup> bit of a 64-bit address is set mentally, `bcal` is for you.
-It has a [`bc`](https://www.gnu.org/software/bc/manual/html_mono/bc.html) mode for general-purpose numerical calculations. Alternatively, it can also use [`calc`](http://www.isthe.com/chongo/tech/comp/calc/) (helps with expressions involving multiple bases).
+It has a [`bc`](https://www.gnu.org/software/bc/manual/html_mono/bc.html) mode for general-purpose numerical calculations. Alternatively, it can also invoke [`calc`](http://www.isthe.com/chongo/tech/comp/calc/) which works better with expressions involving multiple bases.
`bcal` follows Ubuntu's standard unit conversion and notation [policy](https://wiki.ubuntu.com/UnitsPolicy). Only 64-bit operating systems are supported.
diff --git a/bcal.1 b/bcal.1
index a9e1658..dafc9e0 100644
--- a/bcal.1
+++ b/bcal.1
@@ -5,7 +5,13 @@ bcal \- Storage expression calculator.
.B bcal [-c N] [-f loc] [-s bytes] [expr] [N [unit]] [-b [expr]] [-m] [-d] [-h]
.SH DESCRIPTION
.B bcal
-(Byte CALculator) is a command-line utility to help with numerical calculations and expressions involving data storage units, addressing, base conversion etc. It invokes GNU \fBbc\fR for non-storage expressions.
+(Byte CALculator) is a command-line utility to help with numerical calculations and expressions involving data storage units, addressing, base conversion etc.
+.PP
+It invokes GNU \fBbc\fR for non-storage expressions. Alternatively, it can also invoke \fBcalc\fR (\fIhttp://www.isthe.com/chongo/tech/comp/calc/\fR) which works better with expressions involving multiple bases. To use \fBcalc\fR:
+.PP
+.EX
+.B export BCAL_USE_CALC=1
+.EE
.PP
\fBbcal\fR follows Ubuntu's standard unit conversion and notation policy:
.br