From 9a128303b403eacac3db0351fceade7a0e7c5897 Mon Sep 17 00:00:00 2001 From: "B. Watson" Date: Tue, 25 Jun 2024 18:49:54 -0400 Subject: listbas: pipe through a8eol or a8utf8; do not write ATASCII to terminal; add docs. --- listbas.rst | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 listbas.rst (limited to 'listbas.rst') diff --git a/listbas.rst b/listbas.rst new file mode 100644 index 0000000..8c672a2 --- /dev/null +++ b/listbas.rst @@ -0,0 +1,68 @@ +======= +listbas +======= + +-------------------------------------------------------- +List the source of a tokenized Atari 8-bit BASIC program +-------------------------------------------------------- + +.. include:: manhdr.rst + +SYNOPSIS +======== + +listbas [**-v**] [**-i**] **input-file** + +DESCRIPTION +=========== + +**listbas** acts like the *LIST* command in BASIC. It reads a +tokenized (SAVEd) BASIC program and prints the code in human-readable +format. + +By default, output is piped through **a8eol**\(1), to convert ATASCII +characters to human-readable sequences. Raw ATASCII and Unicode output +are also available. + +OPTIONS +======= + +List options +------------ + +**-i** + Include the immediate mode command (line 32768) in the output. + +**-a** + Output raw ATASCII; no translation to the host character set. Must be + used with redirection; **listbas** will not write ATASCII to the terminal. + +**-u** + Use **a8utf8**\(1) to translate ATASCII to ASCII. Requires **a8utf8** + somewhere in *PATH*. + +.. include:: genopts.rst + +NOTES +===== + +**listbas** is similar to Jindroush's **chkbas**. The main differences are: + +- **listbas** only supports Atari BASIC, not Turbo BASIC or BASIC XL/XE. + +- **listbas** doesn't show information about the variables. Use **vxrefbas** + for that. + +- **listbas** will not write ATASCII data to your terminal. Instead, it uses + **a8eol** or **a8utf8** to convert the output to something human-readable + that won't confuse the terminal. + +- **listbas** only includes line 32768 (the immediate mode command) if + specifically asked to do so. + +EXIT STATUS +=========== + +0 for success, 1 for failure. + +.. include:: manftr.rst -- cgit v1.2.3