aboutsummaryrefslogtreecommitdiff
path: root/listbas.1
diff options
context:
space:
mode:
Diffstat (limited to 'listbas.1')
-rw-r--r--listbas.162
1 files changed, 53 insertions, 9 deletions
diff --git a/listbas.1 b/listbas.1
index cf16a93..110fde5 100644
--- a/listbas.1
+++ b/listbas.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "LISTBAS" 1 "2024-07-02" "0.2.1" "Urchlay's Atari 8-bit Tools"
+.TH "LISTBAS" 1 "2024-07-05" "0.2.1" "Urchlay's Atari 8-bit Tools"
.SH NAME
listbas \- List the source of a tokenized Atari 8-bit BASIC program
.SH SYNOPSIS
@@ -39,16 +39,16 @@ listbas [\fB\-v\fP] [\fB\-i\fP] [\fB\-a\fP | \fB\-m\fP ] \fBinput\-file\fP
tokenized (SAVEd) BASIC program and prints the code in human\-readable
format.
.sp
-By default, output is piped through \fBa8cat\fP(1), to covert ATASCII
-characters into Unicode equivalents. Raw ATASCII and "magazine listing"
-mode are also available.
-.sp
-\fBa8cat\fP is run as an external processe. The executables is searched
-for first in the current directory, and then in \fIPATH\fP\&.
+By default, output is Unicode in UTF\-8 encoding, with ANSI/VT220
+escape sequences for inverse video and color syntax highlighting.
.SH OPTIONS
.SS List options
.INDENT 0.0
.TP
+.B \fB\-b\fP
+Use bold, for color output. This may make it easier to read on
+some terminals. Or, it may hurt your eyes...
+.TP
.B \fB\-i\fP
Include the immediate mode command (line 32768) in the output.
.TP
@@ -56,9 +56,12 @@ Include the immediate mode command (line 32768) in the output.
Output raw ATASCII; no translation to the host character set. Must be
used with redirection; \fBlistbas\fP will not write ATASCII to the terminal.
.TP
+.B \fB\-n\fP
+No color. Has no effect if \fB\-a\fP or \fB\-m\fP are in effect, since these
+modes don\(aqt support color anyway.
+.TP
.B \fB\-m\fP
-Output "magazine listing". Pipes output through \fBa8cat \-m\fP; see the man
-page for \fBa8cat\fP for details.
+Output "magazine listing". See the \fB\-m\fP option for \fBa8cat\fP for details.
.UNINDENT
.SS General Options
.INDENT 0.0
@@ -73,6 +76,42 @@ Print version number and exit.
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 COLORS
+.sp
+Color output only works on terminal emulators (or real terminals)
+that support ANSI/VT220 style escape codes. This includes all modern
+terminal emulators, and most not\-so\-modern ones in the UNIX world.
+.sp
+The color scheme is:
+.INDENT 0.0
+.TP
+.B \fByellow\fP
+Commands. Also "command operators" such as the \fBGOTO\fP in \fBON/GOTO\fP and
+the \fBSTEP\fP in a \fBFOR\fP command. These are really operators as far as
+BASIC is concerned, but it makes more sense to colorize them as commands.
+.TP
+.B \fBgreen\fP
+Operators (except functions and "command operators").
+.TP
+.B \fBpurple\fP
+Functions.
+.TP
+.B \fBred\fP
+Numbers (except line numbers at the start of a line) and string
+constants.
+.TP
+.B \fBcyan\fP
+Line numbers at the start of a line, comments (\fBREM\fP text) and \fBDATA\fP elements.
+.UNINDENT
+.sp
+Variable names and commas between \fBDATA\fP elements are not highlighted,
+so they\(aqll appear in the default foreground color (usually white if the
+terminal has a black background, or black if the background is white).
+.sp
+Note that nothing is highlighted in blue. This is because it\(aqs
+difficult to read on many terminals. Also, black and white are not
+used because presumably, one or the other is the background color of
+the terminal.
.SH NOTES
.sp
\fBlistbas\fP will refuse to operate on a LIST\-protected program with
@@ -83,6 +122,11 @@ protection.
\fBlistbas\fP is similar to Jindroush\(aqs \fBchkbas\fP(1). The main differences are:
.INDENT 0.0
.IP \(bu 2
+\fBlistbas\fP prints ATASCII graphics as Unicode equivalents, so the listing
+looks very similar to how it would appear on the Atari.
+.IP \(bu 2
+\fBlistbas\fP does color syntax highlighting.
+.IP \(bu 2
\fBlistbas\fP only supports Atari BASIC, not Turbo BASIC or BASIC XL/XE.
.IP \(bu 2
\fBlistbas\fP doesn\(aqt show information about the variables. Use \fBvxrefbas\fP(1)