summaryrefslogtreecommitdiff
path: root/parserhelp.txt
diff options
context:
space:
mode:
authorMike Buland <mike@xagasoft.com>2014-11-28 11:01:34 -0700
committerMike Buland <mike@xagasoft.com>2014-11-28 11:01:34 -0700
commitb4510a2861acabf1f27ecbd8c42602a0c342763d (patch)
tree94e16d1318c5f7e8da00d1a73b648fc26463deb8 /parserhelp.txt
parent145c88f23e6587e310d3ca974365d20d373d8e1b (diff)
downloadclic-b4510a2861acabf1f27ecbd8c42602a0c342763d.tar.gz
clic-b4510a2861acabf1f27ecbd8c42602a0c342763d.tar.bz2
clic-b4510a2861acabf1f27ecbd8c42602a0c342763d.tar.xz
clic-b4510a2861acabf1f27ecbd8c42602a0c342763d.zip
Switched to using bin2cpp for the help.
I think that's a better practice, it'll be a lot easier to expand it and format it in general, plus it could be compressed if it got too much bigger.
Diffstat (limited to '')
-rw-r--r--parserhelp.txt21
1 files changed, 21 insertions, 0 deletions
diff --git a/parserhelp.txt b/parserhelp.txt
new file mode 100644
index 0000000..0da866c
--- /dev/null
+++ b/parserhelp.txt
@@ -0,0 +1,21 @@
1All commands start with a '\'. The following commands are defined:
2 \help, \h, \? - This help
3 \exit, \quit - Exit the program
4 \radix - Display the current radix (base)
5 \radix <num> - Set the radix to anything between 2 and 36 (inclusive)
6 \scale - Display the current scale
7 \scale <num> - Set the current scale
8 \vars - List all defined variables
9
10All variables must prefixed with a $ but otherwise can be used anywhere a
11number can be used. To assign a variable use =, i.e.:
12 $amnt = $rate * 144000.09
13
14When using a radix greater than 10 all extended digits are lowercase letters
15starting with 'a'. Upper case is not currently supported.
16
17All numeric command parameters (i.e. \scale, \radix) are in base 10 no
18matter what radix is currently set. These are also displayed in base 10
19at all times.
20
21Changing the radix always clears all variables.