aboutsummaryrefslogtreecommitdiff
path: root/listamsb.rst
diff options
context:
space:
mode:
Diffstat (limited to 'listamsb.rst')
-rw-r--r--listamsb.rst61
1 files changed, 61 insertions, 0 deletions
diff --git a/listamsb.rst b/listamsb.rst
new file mode 100644
index 0000000..6bde24d
--- /dev/null
+++ b/listamsb.rst
@@ -0,0 +1,61 @@
+========
+listamsb
+========
+
+------------------------------------------------------------
+List the source of a tokenized Atari Microsoft BASIC program
+------------------------------------------------------------
+
+.. include:: manhdr.rst
+
+SYNOPSIS
+========
+
+listamsb [**-a**\] [**-v**\] [**-h**\] [**-i**\] [**-u**\] [**-t**\] [**-m**\] [**-s**\] [**input-file**\]
+
+DESCRIPTION
+===========
+
+**listamsb** acts like the *LIST* command in Atari Microsoft BASIC. It reads a
+tokenized (SAVEd) AMSB program and prints the code in human-readable
+format.
+
+By default, output is piped to **a8cat**\(1), which converts the
+ATASCII output to something that's human-readable on modern terminals.
+This means **a8cat** must be availabe somewhere in **$PATH**\.
+
+**listamsb** supports both versions of Atari Microsoft BASIC: the
+disk-based version 1 and the cartridge-based version 2. The language
+is the same for both versions, so there's no need to specify it.
+
+**input-file** must be a tokenized AMSB program. If no **input-file** is given,
+input is read from stdin.
+
+Output is to stdout. Use shell redirection to save the output to a file.
+
+OPTIONS
+=======
+
+**-a**
+ Output raw ATASCII. This option must be used with a pipe or redirection, as
+ **listamsb** will not write ATASCII to a terminal. **a8cat** is not used,
+ with this option.
+
+**-v**
+ Verbose output, on stderr.
+
+**-h**
+ Print built-in help and exit.
+
+**-i**\, **-u**\, **-t**\, **-m**\, **-s**
+ These options are passed to **a8cat**. See its man page for details. If
+ the **-a** option is used, these options have no effect.
+
+EXIT STATUS
+===========
+
+0 for success, 1 if there was an error reading the input (e.g. file
+not found), or 2 if the input file has invalid tokens (if this
+happens, you will also see a warning about it on stderr).
+
+.. include:: manftr.rst