path: root/cxrefbas.1

.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CXREFBAS" 1 "2024-07-21" "0.2.1" "Urchlay's Atari 8-bit Tools"
.SH NAME
cxrefbas \- Code cross-reference for tokenized Atari 8-bit BASIC files
.SH SYNOPSIS
.sp
cxrefbas [\fB\-v\fP] \fBinput\-file\fP
.SH DESCRIPTION
.sp
\fBcxrefbas\fP reads an Atari 8\-bit BASIC tokenized program. For each
line number in the program, it prints a list of lines that reference
it.
.sp
\fBinput\-file\fP must be a tokenized (SAVEd) Atari BASIC program. Use
\fI\-\fP to read from standard input, but \fBcxrefbas\fP will refuse to read
from standard input if it\(aqs a terminal.
.sp
Each line number reference in the output is followed by a letter that
indicates the type of reference:
.INDENT 0.0
.TP
.B \fBG\fP
\fIGOTO\fP (without \fION\fP) or \fIGO TO\fP\&.
.TP
.B \fBS\fP
\fIGOSUB\fP (without \fION\fP).
.TP
.B \fBI\fP
\fIIF\fP with line number only, e.g. \fIIF X THEN 1000\fP\&.
.TP
.B \fBO\fP
\fION/GOTO\fP or \fION/GOSUB\fP\&.
.TP
.B \fBR\fP
\fIRESTORE\fP\&.
.TP
.B \fBT\fP
\fITRAP\fP\&.
.TP
.B \fBL\fP
\fILIST\fP\&. It\(aqs very rare for a program to \fILIST\fP parts of itself, but
it\(aqs allowed by BASIC so it\(aqs supported here.
.UNINDENT
.sp
If a line doesn\(aqt exist, but is referenced (e.g. \fIGOTO 100\fP, but there
is no line 100), it\(aqs printed in the table, prefixed with \fI!\fP\&.
.sp
Any command that uses a computed value for a line number will print a
warning on standard error, e.g. \fIGOTO A\fP or \fIGOSUB 100*A\fP\&. Even \fIGOTO
100+0\fP is a computed value, since BASIC doesn\(aqt do constant folding.
.sp
Line numbers above 32767, e.g. \fITRAP 40000\fP, are not listed.
.sp
Atari BASIC allows fractional line numbers, such as \fIGOTO 123.4\fP\&.
These are rounded to the nearest integer when the program is
executed. \fBcxrefbas\fP handles these correctly, although you\(aqre
not likely to run into them in real\-world programs.
.SH OPTIONS
.sp
There are no application\-specific options.
.SS General Options
.INDENT 0.0
.TP
.B \fB\-\-help\fP
Print usage message and exit.
.TP
.B \fB\-\-version\fP
Print version number and exit.
.TP
.B \fB\-v\fP
Verbose operation. When displaying a number in verbose mode, it will
be prefixed with \fI$\fP if it\(aqs in hex, or no prefix for decimal.
.UNINDENT
.SH EXAMPLE
.sp
This program:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
10 GOSUB 100:GOSUB 200
100 RESTORE 1000:IF A THEN 120
110 GOTO 200
120 ON B GOTO 300,310,320
200 RETURN
300 PRINT 1
310 PRINT 2
1000 DATA XYZ
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Produces this output:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
100: 10:S
120: 100:I
200: 10:S 110:G
300: 120:O
310: 120:O
!320: 120:O
1000: 100:R
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Note that line 320 doesn\(aqt exist in the program, so it\(aqs shown with
\fI!\fP in the output. Line 120 has \fI100:I\fP; if the \fITHEN 120\fP were
changed to \fITHEN GOTO 120\fP, line 120 would read \fI100:G\fP\&.
.SH EXIT STATUS
.sp
0 for success, 1 for failure.
.SH COPYRIGHT
.sp
WTFPL. See \fI\%http://www.wtfpl.net/txt/copying/\fP for details.
.SH AUTHOR
.INDENT 0.0
.IP B. 3
Watson <\fI\%urchlay@slackware.uk\fP>; Urchlay on irc.libera.chat \fI##atari\fP\&.
.UNINDENT
.SH SEE ALSO
.sp
\fBa8cat\fP(1),
\fBa8eol\fP(1),
\fBa8xd\fP(1),
\fBatr2xfd\fP(1),
\fBatrsize\fP(1),
\fBaxe\fP(1),
\fBbas2aplus\fP(1),
\fBblob2c\fP(1),
\fBblob2xex\fP(1),
\fBcart2xex\fP(1),
\fBcxrefbas\fP(1),
\fBdasm2atasm\fP(1),
\fBdiffbas\fP(1),
\fBdumpbas\fP(1),
\fBf2toxex\fP(1),
\fBfenders\fP(1),
\fBlistbas\fP(1),
\fBprotbas\fP(1),
\fBrenumbas\fP(1),
\fBrom2cart\fP(1),
\fBunmac65\fP(1),
\fBunprotbas\fP(1),
\fBvxrefbas\fP(1),
\fBwhichbas\fP(1),
\fBxex1to2\fP(1),
\fBxexamine\fP(1),
\fBxexcat\fP(1),
\fBxexsplit\fP(1),
\fBxfd2atr\fP(1),
\fBxex\fP(5),
\fBatascii\fP(7).
.sp
Any good Atari 8\-bit book: \fIDe Re Atari\fP, \fIThe Atari BASIC  Reference
Manual\fP,  the  \fIOS Users\(aq Guide\fP, \fIMapping the Atari\fP, etc.
.\" Generated by docutils manpage writer.
.