aboutsummaryrefslogtreecommitdiff
path: root/abas2html.rst
diff options
context:
space:
mode:
Diffstat (limited to 'abas2html.rst')
-rw-r--r--abas2html.rst86
1 files changed, 86 insertions, 0 deletions
diff --git a/abas2html.rst b/abas2html.rst
new file mode 100644
index 0000000..7085756
--- /dev/null
+++ b/abas2html.rst
@@ -0,0 +1,86 @@
+=========
+abas2html
+=========
+
+--------------------------------------
+Create HTML from tokenized Atari BASIC
+--------------------------------------
+
+.. include:: manhdr.rst
+
+SYNOPSIS
+========
+
+**abas2html** [**-h**] [**-a** *aha-opts*] [**-b** *dialect*] [**-m**] *input-file* [*output-file*]
+
+DESCRIPTION
+===========
+
+**abas2html** is a shell script wrapper for **listbas**\(1),
+**listamsb**\(1), and **aha**\(1). It creates an HTML file of the
+program listing, with color syntax highlighting by default. ATASCII
+characters are converted to Unicode equivalents, and inverse video is
+displayed correctly.
+
+*input-file* must be a tokenized BASIC program, either Atari 8K BASIC,
+OSS BASIC/A+, Atari Microsoft BASIC, Turbo BASIC XL, OSS BASIC XL, or
+OSS BASIC XE. You can specify the BASIC dialect (see **-b**, below) or
+let it be autodetected (via **whichbas**\(1)).
+
+*output-file* will be an HTML file, created by **aha**\(1). If
+no output filename is given, it will be costructed by changing the
+filename extension to *.html*, or (if there is no extension) by adding
+*.html* to the input filename.
+
+**aha** can be installed from https://github.com/theZiz/aha or from
+your distribution's package repository (e.g. **sbopkg -i aha** on Slackware,
+**apt install aha** on Debian or Ubuntu).
+
+OPTIONS
+=======
+
+-a Next option is passed to **aha**\(1). May be used multiple times.
+ Examples::
+
+ abas2html -a -b -a -n FOO.BAS # black background, no header
+ abas2html -a"-b -n" FOO.BAS # same thing, quotes required
+
+-b Set BASIC dialect. Default is autodetection. Valid dialects:
+
+ **-ba** Atari 8K BASIC
+
+ **-ba+** OSS BASIC/A+
+
+ **-bm** Atari Microsoft BASIC
+
+ **-bt** Turbo BASIC XL
+
+ **-bxl** OSS BASIC XL
+
+ **-bxe** OSS BASIC XE
+
+-m Monochrome: disable color syntax highlighting.
+
+ENVIRONMENT
+===========
+
+**PATH**
+ The various programs executed are searched for in **PATH**. If you don't
+ have the utilities installed system-wide, you can use something like::
+
+ PATH=.:$PATH ./abas2html <...>
+
+**LISTBAS_OPTS**
+ See **listbas**\(1) for usage. Note that Atari Microsoft BASIC programs
+ are listed with **listamsb**, which is not affected by this environment
+ variable.
+
+**A8CAT**\, **COLORIZE_AMSB**
+ Used by **listamsb**\(1) when listing Atari Microsoft BASIC programs.
+
+EXIT STATUS
+===========
+
+0 for success, non-zero for failure.
+
+.. include:: manftr.rst