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.1 | 132 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 132 insertions(+) create mode 100644 listbas.1 (limited to 'listbas.1') diff --git a/listbas.1 b/listbas.1 new file mode 100644 index 0000000..888df21 --- /dev/null +++ b/listbas.1 @@ -0,0 +1,132 @@ +.\" 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 "LISTBAS" 1 "2024-06-25" "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 +.sp +listbas [\fB\-v\fP] [\fB\-i\fP] \fBinput\-file\fP +.SH DESCRIPTION +.sp +\fBlistbas\fP acts like the \fILIST\fP command in BASIC. It reads a +tokenized (SAVEd) BASIC program and prints the code in human\-readable +format. +.sp +By default, output is piped through \fBa8eol\fP(1), to convert ATASCII +characters to human\-readable sequences. Raw ATASCII and Unicode output +are also available. +.SH OPTIONS +.SS List options +.INDENT 0.0 +.TP +.B \fB\-i\fP +Include the immediate mode command (line 32768) in the output. +.TP +.B \fB\-a\fP +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\-u\fP +Use \fBa8utf8\fP(1) to translate ATASCII to ASCII. Requires \fBa8utf8\fP +somewhere in \fIPATH\fP\&. +.UNINDENT +.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 NOTES +.sp +\fBlistbas\fP is similar to Jindroush\(aqs \fBchkbas\fP\&. The main differences are: +.INDENT 0.0 +.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 +for that. +.IP \(bu 2 +\fBlistbas\fP will not write ATASCII data to your terminal. Instead, it uses +\fBa8eol\fP or \fBa8utf8\fP to convert the output to something human\-readable +that won\(aqt confuse the terminal. +.IP \(bu 2 +\fBlistbas\fP only includes line 32768 (the immediate mode command) if +specifically asked to do so. +.UNINDENT +.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 +\fBa8eol\fP(1), +\fBa8utf8\fP(1), +\fBatr2xfd\fP(1), +\fBatrsize\fP(1), +\fBaxe\fP(1), +\fBblob2c\fP(1), +\fBblob2xex\fP(1), +\fBcart2xex\fP(1), +\fBcxrefbas\fP(1), +\fBdasm2atasm\fP(1), +\fBdumpbas\fP(1), +\fBf2toxex\fP(1), +\fBfenders\fP(1), +\fBprotbas\fP(1), +\fBrenumbas\fP(1), +\fBrom2cart\fP(1), +\fBunmac65\fP(1), +\fBunprotbas\fP(1), +\fBvxrefbas\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. +. -- cgit v1.2.3