aboutsummaryrefslogtreecommitdiff
path: root/vxrefbas.rst
diff options
context:
space:
mode:
Diffstat (limited to 'vxrefbas.rst')
-rw-r--r--vxrefbas.rst57
1 files changed, 57 insertions, 0 deletions
diff --git a/vxrefbas.rst b/vxrefbas.rst
new file mode 100644
index 0000000..b06deb5
--- /dev/null
+++ b/vxrefbas.rst
@@ -0,0 +1,57 @@
+========
+vxrefbas
+========
+
+--------------------------------------------------------------
+Variable cross-reference for tokenized Atari 8-bit BASIC files
+--------------------------------------------------------------
+
+.. include:: manhdr.rst
+
+SYNOPSIS
+========
+
+vxrefbas **input-file**
+
+DESCRIPTION
+===========
+**vxrefbas** reads an Atari 8-bit BASIC tokenized program and prints
+a list of variables, each with a list of line numbers where the
+variable is referenced.
+
+Variables that aren't used by the program are listed as *(no references)*.
+
+Each line number may be followed by one or more markers, which show the
+type of variable access.
+
+**=**
+ The variable is assigned on this line, with *LET* or "implied LET" (e.g.
+ *A=1*).
+
+**{**
+ The variable is used as the control variable of a *FOR* loop on this line.
+
+**}**
+ The variable is used in a *NEXT* on this line.
+
+OPTIONS
+=======
+
+General Options
+---------------
+**--help**
+ Print usage message and exit.
+
+**--version**
+ Print version number and exit.
+
+**-v**
+ Verbose operation. When displaying a number in verbose mode, it will
+ be prefixed with *$* if it's in hex, or no prefix for decimal.
+
+EXIT STATUS
+===========
+
+0 for success, 1 for failure.
+
+.. include:: manftr.rst