From a4cc3ad3504d634e379369862c9f9fd8eed379f3 Mon Sep 17 00:00:00 2001 From: "B. Watson" Date: Thu, 16 May 2024 01:43:09 -0400 Subject: Add Jindrich Kubec's tools. --- jindroush/man/Makefile | 12 ++++ jindroush/man/acvt.1 | 116 +++++++++++++++++++++++++++++++++ jindroush/man/acvt.rst | 77 ++++++++++++++++++++++ jindroush/man/adir.1 | 141 +++++++++++++++++++++++++++++++++++++++++ jindroush/man/adir.rst | 89 ++++++++++++++++++++++++++ jindroush/man/aext.1 | 55 ++++++++++++++++ jindroush/man/aext.rst | 24 +++++++ jindroush/man/bas2boot.1 | 84 ++++++++++++++++++++++++ jindroush/man/bas2boot.rst | 53 ++++++++++++++++ jindroush/man/chkbas.1 | 155 +++++++++++++++++++++++++++++++++++++++++++++ jindroush/man/chkbas.rst | 118 ++++++++++++++++++++++++++++++++++ jindroush/man/chkexe.1 | 86 +++++++++++++++++++++++++ jindroush/man/chkexe.rst | 55 ++++++++++++++++ jindroush/man/chkrom.1 | 90 ++++++++++++++++++++++++++ jindroush/man/chkrom.rst | 51 +++++++++++++++ jindroush/man/manftr.rst | 21 ++++++ jindroush/man/manhdr.rst | 7 ++ 17 files changed, 1234 insertions(+) create mode 100644 jindroush/man/Makefile create mode 100644 jindroush/man/acvt.1 create mode 100644 jindroush/man/acvt.rst create mode 100644 jindroush/man/adir.1 create mode 100644 jindroush/man/adir.rst create mode 100644 jindroush/man/aext.1 create mode 100644 jindroush/man/aext.rst create mode 100644 jindroush/man/bas2boot.1 create mode 100644 jindroush/man/bas2boot.rst create mode 100644 jindroush/man/chkbas.1 create mode 100644 jindroush/man/chkbas.rst create mode 100644 jindroush/man/chkexe.1 create mode 100644 jindroush/man/chkexe.rst create mode 100644 jindroush/man/chkrom.1 create mode 100644 jindroush/man/chkrom.rst create mode 100644 jindroush/man/manftr.rst create mode 100644 jindroush/man/manhdr.rst (limited to 'jindroush/man') diff --git a/jindroush/man/Makefile b/jindroush/man/Makefile new file mode 100644 index 0000000..bfe47c0 --- /dev/null +++ b/jindroush/man/Makefile @@ -0,0 +1,12 @@ +DESTDIR= +PREFIX=/usr/local +MANDIR=$(PREFIX)/man +MAN1DIR=$(MANDIR)/man1 +GZIP_MAN=y +RST2MAN=rst2man +MANS=acvt.1 adir.1 aext.1 bas2boot.1 chkbas.1 chkexe.1 chkrom.1 + +all: $(MANS) + +%.1: %.rst manhdr.rst manftr.rst + $(RST2MAN) $< > $@ diff --git a/jindroush/man/acvt.1 b/jindroush/man/acvt.1 new file mode 100644 index 0000000..4336fe7 --- /dev/null +++ b/jindroush/man/acvt.1 @@ -0,0 +1,116 @@ +.\" 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 "ACVT" 1 "2024-05-16" "1.07" "Jindroush's Atari 8-bit tools" +.SH NAME +acvt \- convert between Atari 8-bit disk image formats +.SH SYNOPSIS +.sp +acvt [\fB\-xfd\fP | \fB\-atr\fP | \fB\-scp\fP | \fB\-dcm\fP | \fB\-di\fP] [\fB\-batchmode\fP] [\fB\-autorepair\fP] [\fB\-norepair\fP] [\fB\-errstop\fP] [\fB\-over\fP] [\fB\-test\fP] [\fB\-classic\fP] \fIinput\-file\fP [\fIoutput\-file\fP] +.SH DESCRIPTION +.sp +\fBacvt\fP converts Atari 8\-bit images between various formats. It can +also repair some kinds of problems with broken/corrupted images. +.sp +Supported formats are: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.TP +.B ATR +Originally defined by SIOPC; the modern standard format. +.TP +.B XFD +Originally defined by the XFormer emulator; raw images. +.TP +.B DCM +DiskComm (Disk Communicator) images. +.TP +.B SCP +SpartaDOS SCOPY images. +.TP +.B DI +XL/ST link / XLDJ disk images. +.UNINDENT +.UNINDENT +.UNINDENT +.sp +If no \fIoutput\-file\fP is given, the filename is created automatically by +replacing the filename extension (e.g. \fIfoo.xfd\fP becomes \fIfoo.atr\fP). +.sp +If the output file already exists, it will not be overwritten unless +the \fB\-over\fP option is given. +.sp +If the input file is invalid, \fBacvt\fP may prompt for a repair method. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \fB\-xfd\fP, \fB\-atr\fP, \fB\-scp\fP, \fB\-dcm\fP, \fB\-di\fP +Output disk image format. Default is \fB\-atr\fP\&. +.TP +.B \fB\-batchmode\fP +Multi\-file processing mode. Only input files are specified on command\-line. +Regular expressions are allowed. Output filenames are created automatically. +.TP +.B \fB\-autorepair\fP +Automatically determines the best repair method (rather than prompting). +.TP +.B \fB\-norepair\fP +Doesn\(aqt ask for repair options and considers input file invalid if it needs repair. +.TP +.B \fB\-errstop\fP +In batch mode, exits on the first error encountered. +.TP +.B \fB\-over\fP +Overwrites existing files. +.TP +.B \fB\-test\fP +Load input images and display their state, but do not write output. +.TP +.B \fB\-classic\fP +Force output to be one of the classic Atari disk sizes (90K, 128K, 180K). +.UNINDENT +.SH COPYRIGHT +.sp +This utility is released under the GNU General Public License. +.SH AUTHORS +.sp +This utility was written by Jindrich Kubec, AKA Jindroush. +.sp +This page was written by B. Watson <\fI\%urchlay@slackware.uk\fP>. +.SH SEE ALSO +.sp +\fBacvt\fP(1), +\fBaext\fP(1), +\fBbas2boot\fP(1), +\fBchkbas\fP(1), +\fBchkexe\fP(1), +\fBchkrom\fP(1). +.\" Generated by docutils manpage writer. +. diff --git a/jindroush/man/acvt.rst b/jindroush/man/acvt.rst new file mode 100644 index 0000000..925ffbc --- /dev/null +++ b/jindroush/man/acvt.rst @@ -0,0 +1,77 @@ +.. |version| replace:: 1.07 + +==== +acvt +==== + +---------------------------------------------- +convert between Atari 8-bit disk image formats +---------------------------------------------- + +.. include:: manhdr.rst + +SYNOPSIS +======== + +acvt [**-xfd** | **-atr** | **-scp** | **-dcm** | **-di**] [**-batchmode**] [**-autorepair**] [**-norepair**] [**-errstop**] [**-over**] [**-test**] [**-classic**] *input-file* [*output-file*] + +DESCRIPTION +=========== + +**acvt** converts Atari 8-bit images between various formats. It can +also repair some kinds of problems with broken/corrupted images. + +Supported formats are: + + ATR + Originally defined by SIOPC; the modern standard format. + + XFD + Originally defined by the XFormer emulator; raw images. + + DCM + DiskComm (Disk Communicator) images. + + SCP + SpartaDOS SCOPY images. + + DI + XL/ST link / XLDJ disk images. + +If no *output-file* is given, the filename is created automatically by +replacing the filename extension (e.g. *foo.xfd* becomes *foo.atr*). + +If the output file already exists, it will not be overwritten unless +the **-over** option is given. + +If the input file is invalid, **acvt** may prompt for a repair method. + +OPTIONS +======= + +**-xfd**, **-atr**, **-scp**, **-dcm**, **-di** + Output disk image format. Default is **-atr**. + +**-batchmode** + Multi-file processing mode. Only input files are specified on command-line. + Regular expressions are allowed. Output filenames are created automatically. + +**-autorepair** + Automatically determines the best repair method (rather than prompting). + +**-norepair** + Doesn't ask for repair options and considers input file invalid if it needs repair. + +**-errstop** + In batch mode, exits on the first error encountered. + +**-over** + Overwrites existing files. + +**-test** + Load input images and display their state, but do not write output. + +**-classic** + Force output to be one of the classic Atari disk sizes (90K, 128K, 180K). + +.. include:: manftr.rst diff --git a/jindroush/man/adir.1 b/jindroush/man/adir.1 new file mode 100644 index 0000000..8250225 --- /dev/null +++ b/jindroush/man/adir.1 @@ -0,0 +1,141 @@ +.\" 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 "ADIR" 1 "2024-05-16" "0.67" "Jindroush's Atari 8-bit tools" +.SH NAME +adir \- list and extract files from Atari 8-bit disk images +.SH SYNOPSIS +.sp +adir [ [\fB\-help*] | [\fP\-dos2** | [\fB\-dos3\fP] | [\fB\-mydos\fP] | [\fB\-spdos\fP] | [\fB\-kboot\fP] | [\fB\-bas2boot\fP ] | [\fB\-jonw\fP] | [\fB\-robc\fP] | [\fB\-howf\fP] | [\fB\-boot] ] [\fP\-e**] [\fB\-dir\fP \fIpath\fP] [\fB\-dontrepair\fP] \fBdisk\-image\fP [\fBmask\fP] +.SH DESCRIPTION +.sp +\fBadir\fP lists and extracts the files contained in an Atari 8\-bit +disk image. Many Atari DOS and DOS\-like filesystems are supported, +and disk images can be in various formats. +.sp +The image types supported are: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.TP +.B ATR +Originally defined by SIOPC; the modern standard format. +.TP +.B XFD +Originally defined by the XFormer emulator; raw images. +.TP +.B DCM +DiskComm (Disk Communicator) images. +.TP +.B SCP +SpartaDOS SCOPY images. +.TP +.B DI +XL/ST link / XLDJ disk images. +.UNINDENT +.UNINDENT +.UNINDENT +.sp +The image type is autodetected; there are no options to override the +detection. +.sp +The filesystems supported are: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP \(bu 2 +Atari DOS 2.0/2.5 and compatibles +.IP \(bu 2 +Atari DOS 3.0 +.IP \(bu 2 +MyDOS +.IP \(bu 2 +Sparta DOS and compatibles (BeWe, RealDOS) +.IP \(bu 2 +K\-Boot images +.IP \(bu 2 +HowFen DOS +.IP \(bu 2 +JonW multiboot +.IP \(bu 2 +RobC multiboot +.IP \(bu 2 +Bas2Boot images +.IP \(bu 2 +boot images (extracts boot sector only) +.UNINDENT +.UNINDENT +.UNINDENT +.sp +By default, \fBadir\fP attempts to autodetect the filesystem type, but it can +be set explicitly by one of the options, below. +.sp +\fBmask\fP is a wildcard mask of filenames to extract. Note that +it\(aqs case\-sensitive, meaning it generally will have to be given in +uppercase since most Atari filesystems don\(aqt support lowercase. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \fB\-dos2\fP, \fB\-dos3\fP, \fB\-mydos\fP, \fB\-spdos\fP, \fB\-kboot\fP, \fB\-bas2boot\fP, \fB\-jonw\fP, \fB\-robc\fP, \fB\-howf\fP, \fB\-boot\fP +Set the filesystem type (see list, above). +.TP +.B \fB\-e\fP +Extracts files from the image. If a wildcard \fBmask\fP is given, +files matching the wildcard will be listed (and extracted, with +\fB\-e\fP). Without a \fBmask\fP, all files on the image will be +listed/extracted. +.TP +.B \fB\-dir\fP \fIpath\fP +Write extracted files to this directory, which will be created if it +doesn\(aqt already exist. Default is "." (the current directory). +.TP +.B \fB\-dontrepair\fP +Don\(aqt attempt to automatically repair invalid files. +.UNINDENT +.SH EXIT STATUS +.sp +Zero for success, non\-zero for failure. +.SH COPYRIGHT +.sp +This utility is released under the GNU General Public License. +.SH AUTHORS +.sp +This utility was written by Jindrich Kubec, AKA Jindroush. +.sp +This page was written by B. Watson <\fI\%urchlay@slackware.uk\fP>. +.SH SEE ALSO +.sp +\fBacvt\fP(1), +\fBaext\fP(1), +\fBbas2boot\fP(1), +\fBchkbas\fP(1), +\fBchkexe\fP(1), +\fBchkrom\fP(1). +.\" Generated by docutils manpage writer. +. diff --git a/jindroush/man/adir.rst b/jindroush/man/adir.rst new file mode 100644 index 0000000..eff5911 --- /dev/null +++ b/jindroush/man/adir.rst @@ -0,0 +1,89 @@ +.. |version| replace:: 0.67 + +==== +adir +==== + +--------------------------------------------------- +list and extract files from Atari 8-bit disk images +--------------------------------------------------- + +.. include:: manhdr.rst + +SYNOPSIS +======== + +adir [ [**-help*] | [**-dos2** | [**-dos3**] | [**-mydos**] | [**-spdos**] | [**-kboot**] | [**-bas2boot** ] | [**-jonw**] | [**-robc**] | [**-howf**] | [**-boot] ] [**-e**] [**-dir** *path*] [**-dontrepair**] **disk-image** [**mask**] + +DESCRIPTION +=========== + +**adir** lists and extracts the files contained in an Atari 8-bit +disk image. Many Atari DOS and DOS-like filesystems are supported, +and disk images can be in various formats. + +The image types supported are: + + ATR + Originally defined by SIOPC; the modern standard format. + + XFD + Originally defined by the XFormer emulator; raw images. + + DCM + DiskComm (Disk Communicator) images. + + SCP + SpartaDOS SCOPY images. + + DI + XL/ST link / XLDJ disk images. + +The image type is autodetected; there are no options to override the +detection. + +The filesystems supported are: + + - Atari DOS 2.0/2.5 and compatibles + - Atari DOS 3.0 + - MyDOS + - Sparta DOS and compatibles (BeWe, RealDOS) + - K-Boot images + - HowFen DOS + - JonW multiboot + - RobC multiboot + - Bas2Boot images + - boot images (extracts boot sector only) + +By default, **adir** attempts to autodetect the filesystem type, but it can +be set explicitly by one of the options, below. + +**mask** is a wildcard mask of filenames to extract. Note that +it's case-sensitive, meaning it generally will have to be given in +uppercase since most Atari filesystems don't support lowercase. + +OPTIONS +======= + +**-dos2**, **-dos3**, **-mydos**, **-spdos**, **-kboot**, **-bas2boot**, **-jonw**, **-robc**, **-howf**, **-boot** + Set the filesystem type (see list, above). + +**-e** + Extracts files from the image. If a wildcard **mask** is given, + files matching the wildcard will be listed (and extracted, with + **-e**). Without a **mask**, all files on the image will be + listed/extracted. + +**-dir** *path* + Write extracted files to this directory, which will be created if it + doesn't already exist. Default is "." (the current directory). + +**-dontrepair** + Don't attempt to automatically repair invalid files. + +EXIT STATUS +=========== + +Zero for success, non-zero for failure. + +.. include:: manftr.rst diff --git a/jindroush/man/aext.1 b/jindroush/man/aext.1 new file mode 100644 index 0000000..534c2da --- /dev/null +++ b/jindroush/man/aext.1 @@ -0,0 +1,55 @@ +.\" 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 "AEXT" 1 "2024-05-16" "1.02" "Jindroush's Atari 8-bit tools" +.SH NAME +aext \- extract binary blocks from Atari 8-bit disk images +.SH SYNOPSIS +.sp +aext [\fB\-s\fP \fIstart\fP] [\fB\-e\fP \fIend\fP] [\fB\-l\fP \fIlength\fP] [\fB\-oa\fP] [\fB\-base\fP] \fBinput\-file\fP [\fBoutput\-file\fP] +.SH DESCRIPTION +.SH OPTIONS +.SH COPYRIGHT +.sp +This utility is released under the GNU General Public License. +.SH AUTHORS +.sp +This utility was written by Jindrich Kubec, AKA Jindroush. +.sp +This page was written by B. Watson <\fI\%urchlay@slackware.uk\fP>. +.SH SEE ALSO +.sp +\fBacvt\fP(1), +\fBaext\fP(1), +\fBbas2boot\fP(1), +\fBchkbas\fP(1), +\fBchkexe\fP(1), +\fBchkrom\fP(1). +.\" Generated by docutils manpage writer. +. diff --git a/jindroush/man/aext.rst b/jindroush/man/aext.rst new file mode 100644 index 0000000..ed8fb98 --- /dev/null +++ b/jindroush/man/aext.rst @@ -0,0 +1,24 @@ +.. |version| replace:: 1.02 + +==== +aext +==== + +-------------------------------------------------- +extract binary blocks from Atari 8-bit disk images +-------------------------------------------------- + +.. include:: manhdr.rst + +SYNOPSIS +======== + +aext [**-s** *start*] [**-e** *end*] [**-l** *length*] [**-oa**] [**-base**] **input-file** [**output-file**] + +DESCRIPTION +=========== + +OPTIONS +======= + +.. include:: manftr.rst diff --git a/jindroush/man/bas2boot.1 b/jindroush/man/bas2boot.1 new file mode 100644 index 0000000..7e838db --- /dev/null +++ b/jindroush/man/bas2boot.1 @@ -0,0 +1,84 @@ +.\" 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 "BAS2BOOT" 1 "2024-05-16" "1.0.2" "Jindroush's Atari 8-bit tools" +.SH NAME +bas2boot \- make a bootable Atari 8-bit disk image of a BASIC program +.SH SYNOPSIS +.sp +bas2boot [\fB\-atr\fP | \fB\-xfd\fP | \fB\-scp\fP | \fB\-dcm\fP | \fB\-di\fP] [\fB\-long\fP] [\fB\-message\fP \fItext\fP] \fBbasic\-file\fP [\fBoutput\-disk\-image\fP] +.SH DESCRIPTION +.sp +\fBbas2boot\fP creates an Atari 8\-bit disk image that consists of a boot +loader followed by a tokenized Atari BASIC program. When the disk is +booted on the Atari, the BASIC program is loaded into memory and run. +.sp +There is no DOS on the disk; the BASIC program won\(aqt be able to use +the D: devices. +.sp +The bootloader will enable BASIC if possible (600XL, 800XL, all +XEs). Otherwise (400/800/1200XL), the Atari BASIC cartridge must be +inserted. The bootloader doesn\(aqt work with other BASICs like BASIC XL, +TurboBASIC, etc. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \fB\-atr\fP \fB\-xfd\fP \fB\-scp\fP \fB\-dcm\fP \fB\-di\fP +Set the output image type. Default: \fB\-atr\fP\&. Note that the image +type is \fInot\fP affected by the filename extension (the default +is still \fB\-atr\fP even with a file called \fIoutput.xfd\fP). +.TP +.B \fB\-long\fP +Use \(aqclassic\(aq disk size (single density, 90KB). Default is to create a +short ATR file consisting only of the sectors used. +.TP +.B \fB\-message\fP \fItext\fP +Sets message displayed while the program is loading. +.UNINDENT +.SH EXIT STATUS +.sp +Zero for success, non\-zero for failure. +.SH COPYRIGHT +.sp +This utility is released under the GNU General Public License. +.SH AUTHORS +.sp +This utility was written by Jindrich Kubec, AKA Jindroush. +.sp +This page was written by B. Watson <\fI\%urchlay@slackware.uk\fP>. +.SH SEE ALSO +.sp +\fBacvt\fP(1), +\fBaext\fP(1), +\fBbas2boot\fP(1), +\fBchkbas\fP(1), +\fBchkexe\fP(1), +\fBchkrom\fP(1). +.\" Generated by docutils manpage writer. +. diff --git a/jindroush/man/bas2boot.rst b/jindroush/man/bas2boot.rst new file mode 100644 index 0000000..c5273e6 --- /dev/null +++ b/jindroush/man/bas2boot.rst @@ -0,0 +1,53 @@ +.. |version| replace:: 1.0.2 + +======== +bas2boot +======== + +--------------------------------------------------------- +make a bootable Atari 8-bit disk image of a BASIC program +--------------------------------------------------------- + +.. include:: manhdr.rst + +SYNOPSIS +======== + +bas2boot [**-atr** | **-xfd** | **-scp** | **-dcm** | **-di**] [**-long**] [**-message** *text*] **basic-file** [**output-disk-image**] + +DESCRIPTION +=========== + +**bas2boot** creates an Atari 8-bit disk image that consists of a boot +loader followed by a tokenized Atari BASIC program. When the disk is +booted on the Atari, the BASIC program is loaded into memory and run. + +There is no DOS on the disk; the BASIC program won't be able to use +the D: devices. + +The bootloader will enable BASIC if possible (600XL, 800XL, all +XEs). Otherwise (400/800/1200XL), the Atari BASIC cartridge must be +inserted. The bootloader doesn't work with other BASICs like BASIC XL, +TurboBASIC, etc. + +OPTIONS +======= + +**-atr** **-xfd** **-scp** **-dcm** **-di** + Set the output image type. Default: **-atr**. Note that the image + type is *not* affected by the filename extension (the default + is still **-atr** even with a file called *output.xfd*). + +**-long** + Use 'classic' disk size (single density, 90KB). Default is to create a + short ATR file consisting only of the sectors used. + +**-message** *text* + Sets message displayed while the program is loading. + +EXIT STATUS +=========== + +Zero for success, non-zero for failure. + +.. include:: manftr.rst diff --git a/jindroush/man/chkbas.1 b/jindroush/man/chkbas.1 new file mode 100644 index 0000000..1069d6c --- /dev/null +++ b/jindroush/man/chkbas.1 @@ -0,0 +1,155 @@ +.\" 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 "CHKBAS" 1 "2024-05-16" "1.10" "Jindroush's Atari 8-bit tools" +.SH NAME +chkbas \- check and detokenize Atari BASIC SAVEd files +.SH SYNOPSIS +.sp +chkbas [\fB\-atari\fP] [\fB\-short\fP] [\fB\-verbose\fP] [\fB\-noinverse\fP] [\fB\-tbs\fP | \fB\-bxl\fP | \fB\-bxe\fP] \fBbasic\-file\fP [\fBoutput\-file\fP] +.sp +listbas [\fB\-atari\fP] [\fB\-verbose\fP] [\fB\-noinverse\fP] [\fB\-tbs\fP | \fB\-bxl\fP | \fB\-bxe\fP] \fBbasic\-file\fP [\fBoutput\-file\fP] +.SH DESCRIPTION +.sp +\fBchkbas\fP detokenizes Atari 8\-bit BASIC SAVEd files. It lists the BASIC +code in human\-readable form, and gives some other useful information +about the program. +.sp +\fBbasic\-file\fP is an Atari BASIC, TurboBASIC, BASIC XL, or BASIC +XE program. Output will go to \fBoutput\-file\fP, if given; otherwise, +standard output. If \fBbasic\-file\fP is anything other than standard +Atari BASIC, the BASIC dialect must be specified (see \fBOPTIONS\fP, +below). +.sp +\fBlistbas\fP is simply an alias for \fBchkbas \-short\fP\&. +.sp +Sample run, with no options: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ chkbas HELLO.BAS +chkbas v1.10 (c) 1999\-2001 Jindrich Kubec + +chkbas v1.10 (c) 1999\-2001 Jindrich Kubec +Atari Basic/Turbo Basic/Basic XL/Basic XE decompiler. + Latest version can be found at http://www.asw.cz/~kubecj + Published under GPL. See GPL.TXT. + Thanks to Russ Gilbert for his SALVAGE programs. + +Input file: HELLO.BAS + +Constants & pointers: +Start of Name Table (VNT) : 000E +End of Name Table (VNTE) : 0011 +Lenght of Name Table (VNTL) : 0004 +Start of Variable Table (VVT) : 0012 +End of Variable Table (VVTE) : 0021 +Length of Variable Table (VVTL) : 0010 +Number of Variables (NV) : 0002 +Start of Code (STMTAB): 0022 +Length of Code : 004E +Current command (STMCUR): 0070 +Length of current command : 0013 +First byte after program (STARP) : 0083 +Length of file : 0083 +File len difference : 00000000 + +Variable table: +0001 STRING (81) 00: SPoff: 0000 Len: 5 Dim: 10 A$ +0002 SCALAR (00) 01: 11 I + +Main code starts here: +10 DIM A$(10) +20 A$="HELLO" +30 FOR I=1 TO 10 +40 ? A$;" WORLD!" +50 NEXT I + +Immediate code starts here: +32768 SAVE "H:HELLO.BAS" + +Done! +.ft P +.fi +.UNINDENT +.UNINDENT +.SH OPTIONS +.SS Input Options +.INDENT 0.0 +.TP +.B \fB\-tbs\fP +Treat input as a Turbo BASIC program. +.TP +.B \fB\-bxl\fP +Treat input as a BASIC XL program. +.TP +.B \fB\-bxe\fP +Treat input as a BASIC XE program, which may or may not be EXTENDed +with code in the extra XE banks. +.UNINDENT +.SS Output Options +.INDENT 0.0 +.TP +.B \fB\-atari\fP +Output only the program listing, with lines terminated by Atari +EOL characters (\fB$9B\fP). +.TP +.B \fB\-short\fP +Output only the program listing, with lines terminated by the +system default newline character(s), e.g. \fBn\fP on UNIX\-like OSes, +\fBrn\fP on MS\-DOS or Windows. This is the default for \fBlistbas\fP\&. +.TP +.B \fB\-verbose\fP +Program listing will be interspersed with per\-line and per\-statement +low\-level information. This option is probably most useful for debugging +\fBchkbas\fP itself. +.UNINDENT +.SH EXIT STATUS +.sp +Zero for success, non\-zero for failure. +.SH COPYRIGHT +.sp +This utility is released under the GNU General Public License. +.SH AUTHORS +.sp +This utility was written by Jindrich Kubec, AKA Jindroush. +.sp +This page was written by B. Watson <\fI\%urchlay@slackware.uk\fP>. +.SH SEE ALSO +.sp +\fBacvt\fP(1), +\fBaext\fP(1), +\fBbas2boot\fP(1), +\fBchkbas\fP(1), +\fBchkexe\fP(1), +\fBchkrom\fP(1). +.\" Generated by docutils manpage writer. +. diff --git a/jindroush/man/chkbas.rst b/jindroush/man/chkbas.rst new file mode 100644 index 0000000..2f9e6b7 --- /dev/null +++ b/jindroush/man/chkbas.rst @@ -0,0 +1,118 @@ +.. |version| replace:: 1.10 + +====== +chkbas +====== + +-------------------------------------------- +check and detokenize Atari BASIC SAVEd files +-------------------------------------------- + +.. include:: manhdr.rst + +SYNOPSIS +======== + +chkbas [**-atari**] [**-short**] [**-verbose**] [**-noinverse**] [**-tbs** | **-bxl** | **-bxe**] **basic-file** [**output-file**] + +listbas [**-atari**] [**-verbose**] [**-noinverse**] [**-tbs** | **-bxl** | **-bxe**] **basic-file** [**output-file**] + +DESCRIPTION +=========== + +**chkbas** detokenizes Atari 8-bit BASIC SAVEd files. It lists the BASIC +code in human-readable form, and gives some other useful information +about the program. + +**basic-file** is an Atari BASIC, TurboBASIC, BASIC XL, or BASIC +XE program. Output will go to **output-file**, if given; otherwise, +standard output. If **basic-file** is anything other than standard +Atari BASIC, the BASIC dialect must be specified (see **OPTIONS**, +below). + +**listbas** is simply an alias for **chkbas -short**. + +Sample run, with no options:: + + $ chkbas HELLO.BAS + chkbas v1.10 (c) 1999-2001 Jindrich Kubec + + chkbas v1.10 (c) 1999-2001 Jindrich Kubec + Atari Basic/Turbo Basic/Basic XL/Basic XE decompiler. + Latest version can be found at http://www.asw.cz/~kubecj + Published under GPL. See GPL.TXT. + Thanks to Russ Gilbert for his SALVAGE programs. + + Input file: HELLO.BAS + + Constants & pointers: + Start of Name Table (VNT) : 000E + End of Name Table (VNTE) : 0011 + Lenght of Name Table (VNTL) : 0004 + Start of Variable Table (VVT) : 0012 + End of Variable Table (VVTE) : 0021 + Length of Variable Table (VVTL) : 0010 + Number of Variables (NV) : 0002 + Start of Code (STMTAB): 0022 + Length of Code : 004E + Current command (STMCUR): 0070 + Length of current command : 0013 + First byte after program (STARP) : 0083 + Length of file : 0083 + File len difference : 00000000 + + Variable table: + 0001 STRING (81) 00: SPoff: 0000 Len: 5 Dim: 10 A$ + 0002 SCALAR (00) 01: 11 I + + Main code starts here: + 10 DIM A$(10) + 20 A$="HELLO" + 30 FOR I=1 TO 10 + 40 ? A$;" WORLD!" + 50 NEXT I + + Immediate code starts here: + 32768 SAVE "H:HELLO.BAS" + + Done! + +OPTIONS +======= + +Input Options +------------- + +**-tbs** + Treat input as a Turbo BASIC program. + +**-bxl** + Treat input as a BASIC XL program. + +**-bxe** + Treat input as a BASIC XE program, which may or may not be EXTENDed + with code in the extra XE banks. + +Output Options +-------------- + +**-atari** + Output only the program listing, with lines terminated by Atari + EOL characters (**$9B**). + +**-short** + Output only the program listing, with lines terminated by the + system default newline character(s), e.g. **\n** on UNIX-like OSes, + **\r\n** on MS-DOS or Windows. This is the default for **listbas**. + +**-verbose** + Program listing will be interspersed with per-line and per-statement + low-level information. This option is probably most useful for debugging + **chkbas** itself. + +EXIT STATUS +=========== + +Zero for success, non-zero for failure. + +.. include:: manftr.rst diff --git a/jindroush/man/chkexe.1 b/jindroush/man/chkexe.1 new file mode 100644 index 0000000..c266a03 --- /dev/null +++ b/jindroush/man/chkexe.1 @@ -0,0 +1,86 @@ +.\" 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 "CHKEXE" 1 "2024-05-16" "2.62" "Jindroush's Atari 8-bit tools" +.SH NAME +chkexe \- check and/or disassemble Atari 8-bit executables +.SH SYNOPSIS +.sp +chkexe [\fB\-gaps\fP \fIgap\-size\fP] [\fB\-silent\fP] [\fB\-split\fP] [\fB\-d\fP] \fBxex\-file\fP [\fBoutput\-file\fP] +.SH DESCRIPTION +.sp +\fBchkexe\fP reads an Atari 8\-bit executable (aka XEX file) and prints a +list of segments, each with their start and end address. Run and init +addresses are decoded. +.sp +If no \fBoutput\-file\fP is given, \fBchkexe\fP simply prints the results of +its analysis. With an \fBoutput\-file\fP, a possibly modified copy of the +XEX file is created: Adjacent blocks (e.g. a block ending at $1FFF, +followed by a block beginning at $2000) will be combined. The \fB\-gaps\fP +option can be used to control the threshold for combining blocks. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \fB\-gaps\fP \fIgap\-size\fP +Blocks less than \fIgap\-size\fP bytes apart will be combined. Default: \fI0\fP\&. +.TP +.B \fB\-silent\fP +Don\(aqt print informational messages. +.TP +.B \fB\-split\fP +Split multi\-segment executables into one file per segment. The output +files will be called \fIblkNNNN.blk\fP, where \fINNNN\fP is the block number in +hexadecimal. These files are standard Atari executables, with \fI$FFFF\fP +headers. +.TP +.B \fB\-d\fP +Disassemble each block. The disassembler is very simple: single pass, +no attempt to recognize data blocks. +.UNINDENT +.SH EXIT STATUS +.sp +Zero for success, non\-zero for failure. +.SH COPYRIGHT +.sp +This utility is released under the GNU General Public License. +.SH AUTHORS +.sp +This utility was written by Jindrich Kubec, AKA Jindroush. +.sp +This page was written by B. Watson <\fI\%urchlay@slackware.uk\fP>. +.SH SEE ALSO +.sp +\fBacvt\fP(1), +\fBaext\fP(1), +\fBbas2boot\fP(1), +\fBchkbas\fP(1), +\fBchkexe\fP(1), +\fBchkrom\fP(1). +.\" Generated by docutils manpage writer. +. diff --git a/jindroush/man/chkexe.rst b/jindroush/man/chkexe.rst new file mode 100644 index 0000000..91c65ab --- /dev/null +++ b/jindroush/man/chkexe.rst @@ -0,0 +1,55 @@ +.. |version| replace:: 2.62 + +====== +chkexe +====== + +------------------------------------------------ +check and/or disassemble Atari 8-bit executables +------------------------------------------------ + +.. include:: manhdr.rst + +SYNOPSIS +======== + +chkexe [**-gaps** *gap-size*] [**-silent**] [**-split**] [**-d**] **xex-file** [**output-file**] + +DESCRIPTION +=========== + +**chkexe** reads an Atari 8-bit executable (aka XEX file) and prints a +list of segments, each with their start and end address. Run and init +addresses are decoded. + +If no **output-file** is given, **chkexe** simply prints the results of +its analysis. With an **output-file**, a possibly modified copy of the +XEX file is created: Adjacent blocks (e.g. a block ending at $1FFF, +followed by a block beginning at $2000) will be combined. The **-gaps** +option can be used to control the threshold for combining blocks. + +OPTIONS +======= + +**-gaps** *gap-size* + Blocks less than *gap-size* bytes apart will be combined. Default: *0*. + +**-silent** + Don't print informational messages. + +**-split** + Split multi-segment executables into one file per segment. The output + files will be called *blkNNNN.blk*, where *NNNN* is the block number in + hexadecimal. These files are standard Atari executables, with *$FFFF* + headers. + +**-d** + Disassemble each block. The disassembler is very simple: single pass, + no attempt to recognize data blocks. + +EXIT STATUS +=========== + +Zero for success, non-zero for failure. + +.. include:: manftr.rst diff --git a/jindroush/man/chkrom.1 b/jindroush/man/chkrom.1 new file mode 100644 index 0000000..772f7b8 --- /dev/null +++ b/jindroush/man/chkrom.1 @@ -0,0 +1,90 @@ +.\" 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 "CHKROM" 1 "2024-05-16" "1.00" "Jindroush's Atari 8-bit tools" +.SH NAME +chkrom \- check or disassemble 8K or 16K Atari 8-bit cartridge images +.SH SYNOPSIS +.sp +chkrom [\fB\-disassemble\fP] \fBrom\-image\fP +.SH DESCRIPTION +.sp +\fBchkrom\fP reads a \fIraw\fP Atari 8\-bit ROM image (not a \fB\&.car\fP file) +and prints the run address, init address, and the decoded flags in the +cartridge options byte. +.sp +Sample run: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +$ chkrom basic.rom +chkrom v1.00 (c) 1998\-1999 Jindrich Kubec +ROM file: basic.rom +Init Addr :BFF0 +Run Addr :A000 +Flags :0500 ( INIT&RUN BOOT ) +Ok! +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +\fBchkrom\fP only supports images exactly 8KB (8192 bytes) or 16KB +(16384 bytes). Bankswitched cartridge aren\(aqt supported. If you get +"Unknown ROM size", make sure you\(aqre using a raw image. If it\(aqs a +\fB\&.car\fP image, use \fBcart2rom\fP(1) to make a raw image of it. +.SH OPTIONS +.INDENT 0.0 +.TP +.B \fB\-disassemble\fP +Prints a disassembly of the entire cartridge. +.UNINDENT +.SH EXIT STATUS +.sp +Zero for success, non\-zero for failure. +.SH COPYRIGHT +.sp +This utility is released under the GNU General Public License. +.SH AUTHORS +.sp +This utility was written by Jindrich Kubec, AKA Jindroush. +.sp +This page was written by B. Watson <\fI\%urchlay@slackware.uk\fP>. +.SH SEE ALSO +.sp +\fBacvt\fP(1), +\fBaext\fP(1), +\fBbas2boot\fP(1), +\fBchkbas\fP(1), +\fBchkexe\fP(1), +\fBchkrom\fP(1). +.\" Generated by docutils manpage writer. +. diff --git a/jindroush/man/chkrom.rst b/jindroush/man/chkrom.rst new file mode 100644 index 0000000..5db1b15 --- /dev/null +++ b/jindroush/man/chkrom.rst @@ -0,0 +1,51 @@ +.. |version| replace:: 1.00 + +====== +chkrom +====== + +----------------------------------------------------------- +check or disassemble 8K or 16K Atari 8-bit cartridge images +----------------------------------------------------------- + +.. include:: manhdr.rst + +SYNOPSIS +======== + +chkrom [**-disassemble**] **rom-image** + +DESCRIPTION +=========== + +**chkrom** reads a *raw* Atari 8-bit ROM image (not a **.car** file) +and prints the run address, init address, and the decoded flags in the +cartridge options byte. + +Sample run:: + + $ chkrom basic.rom + chkrom v1.00 (c) 1998-1999 Jindrich Kubec + ROM file: basic.rom + Init Addr :BFF0 + Run Addr :A000 + Flags :0500 ( INIT&RUN BOOT ) + Ok! + +**chkrom** only supports images exactly 8KB (8192 bytes) or 16KB +(16384 bytes). Bankswitched cartridge aren't supported. If you get +"Unknown ROM size", make sure you're using a raw image. If it's a +**.car** image, use **cart2rom**\(1) to make a raw image of it. + +OPTIONS +======= + +**-disassemble** + Prints a disassembly of the entire cartridge. + +EXIT STATUS +=========== + +Zero for success, non-zero for failure. + +.. include:: manftr.rst diff --git a/jindroush/man/manftr.rst b/jindroush/man/manftr.rst new file mode 100644 index 0000000..192a1b4 --- /dev/null +++ b/jindroush/man/manftr.rst @@ -0,0 +1,21 @@ +COPYRIGHT +========= + +This utility is released under the GNU General Public License. + +AUTHORS +======= + +This utility was written by Jindrich Kubec, AKA Jindroush. + +This page was written by B. Watson . + +SEE ALSO +======== + +**acvt**\(1), +**aext**\(1), +**bas2boot**\(1), +**chkbas**\(1), +**chkexe**\(1), +**chkrom**\(1). diff --git a/jindroush/man/manhdr.rst b/jindroush/man/manhdr.rst new file mode 100644 index 0000000..b3db233 --- /dev/null +++ b/jindroush/man/manhdr.rst @@ -0,0 +1,7 @@ +.. |date| date:: + +:Manual section: 1 +:Manual group: Jindroush's Atari 8-bit tools +:Date: |date| +:Version: |version| + -- cgit v1.2.3