aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorB. Watson <urchlay@slackware.uk>2024-05-10 19:22:06 -0400
committerB. Watson <urchlay@slackware.uk>2024-05-10 19:32:35 -0400
commit128516c4ac393b583db4b67bde78aa74301d6bff (patch)
treea62d75b9e75e30c49864b53170279708e0819828
parent6845ac01704d75c0c410d9976b322d3bc17892fb (diff)
downloadbw-atari8-tools-128516c4ac393b583db4b67bde78aa74301d6bff.tar.gz
convert ksiders man pages to RST, part 3.
-rw-r--r--ksiders/makeatr.1183
-rw-r--r--ksiders/makeatr.rst81
-rw-r--r--ksiders/unmakatr.170
-rw-r--r--ksiders/unmakatr.rst36
4 files changed, 296 insertions, 74 deletions
diff --git a/ksiders/makeatr.1 b/ksiders/makeatr.1
index fc2ab5a..79248e2 100644
--- a/ksiders/makeatr.1
+++ b/ksiders/makeatr.1
@@ -1,92 +1,127 @@
-.TH MAKEATR,UNMAKATR "1" "April 2007" "makeatr, unmakatr" "Ken Siders' Atari 8-bit Tools"
+.\" 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 "MAKEATR" 1 "2024-05-10" "0.9.0" "Ken Siders' Atari 8-bit Tools"
.SH NAME
-\fBmakeatr\fR \- convert an Atari executable to a "K-file" bootable disk
-.br
-\fBunmakatr\fR \- extract original executable from a disk made with \fBmakeatr\fR
-
+makeatr \- convert an Atari executable to a "K-file" bootable disk
.SH SYNOPSIS
-\fBmakeatr\fR \fIimagefile.atr\fR \fIatari-exe\fR
-.br
-\fBunmakeatr\fR \fIimagefile.atr\fR \fIatari-exe\fR
-
+.sp
+makeatr \fIimagefile.atr\fP \fIatari\-executable\fP
.SH DESCRIPTION
-For various reasons, it's sometimes useful to make a bootable disk image
-of an Atari executable. \fBmakeatr\fR does exactly that.
-.PP
-If you have a bootable image made with \fBmakeatr\fR, but you've lost the
-original executable, you can extract it from the image with \fBunmakatr\fR.
-.PP
+.sp
+For various reasons, it\(aqs sometimes useful to make a bootable disk
+image of an Atari executable. \fBmakeatr\fP does exactly that.
+.sp
+If you have a bootable image made with \fBmakeatr\fP, but you\(aqve lost
+the original executable, you can extract it from the image with
+\fBunmakatr\fP(1).
.SH NOTES
-\fBmakeatr\fR is only useful for single\-file games or other programs that
-don't need DOS disk access to run: the bootable image won't contain
-any DOS at all, or even a DOS file structure (you can't read the directory).
-.PP
-\fBunmakatr\fR only works for images created by \fBmakeatr\fR. It is not
-a general-purpose bootdisk-to-executable utility.
-.PP
-Disks made with \fBmakeatr\fR are recognizable when booted on the Atari,
-because they display GR.0 screen with a lowercase \fIk\fR
-(screen is otherwise blank).
-.PP
-Disk images made with \fBmakeatr\fR are only created with enough sectors
+.sp
+\fBmakeatr\fP is only useful for single\-file games or other programs
+that don\(aqt need DOS disk access to run: the bootable image
+won\(aqt contain any DOS at all, or even a DOS file structure
+(you can\(aqt read the directory).
+.sp
+Disks made with \fBmakeatr\fP are recognizable when booted on the Atari,
+because they display a GRAPHICS 0 screen with a lowercase k (screen
+is otherwise blank).
+.sp
+Disk images made with \fBmakeatr\fP are only created with enough sectors
to hold the executable. AtariSIO can handle these images fine, as can
-most other ATR utilities, but the smaller-than-regulation size may cause
-problems with some utilities.
-.PP
-There is only one Atari executable format, regardless of filename extension.
-All .XEX, .COM, .BIN, .EXE, etc. files for the Atari are the same file type,
-regardless of the name, and regardless of what you may have read on some
-forum site. Atari DOS doesn't care about the filename; it only exists for
-human consumption (and for filetype association with emulators, these
-days).
-
+most other ATR utilities, but the smaller\-than\-regulation size may
+cause problems with some utilities.
+.sp
+There is only one Atari executable format, regardless of filename
+extension. All .XEX, .COM, .BIN, .EXE, etc. files for the Atari are
+the same file type, regardless of the name, and regardless of what
+you may have read on some forum site. Atari DOS doesn\(aqt care about
+the filename; it only exists for human consumption (and for filetype
+association with emulators, these days).
.SH DIAGNOSTICS
-\fBmakeatr\fR's error messages are not well documented. They consist only
+.sp
+\fBmakeatr\fP\(aqs error messages are not well documented. They consist only
of an internal error number code, listed here:
-.PP
+.INDENT 0.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
.B 1
-\- Unable to open ATR image for writing
-.br
+Unable to open ATR image for writing
+.TP
.B 2
-\- Unable to write image ATR header
-.br
+Unable to write image ATR header
+.TP
.B 6
-\- Unable to write boot sectors to ATR image
-.br
+Unable to write boot sectors to ATR image
+.TP
.B 7
-\- Error while padding ATR image to an even sector size
-.br
+Error while padding ATR image to an even sector size
+.TP
.B 11
-\- Unable to stat the input file (not found, permission denied, etc)
-.br
+Unable to stat the input file (not found, permission denied, etc)
+.TP
.B 12
-\- Input file is 0 bytes in length
-.br
+Input file is 0 bytes in length
+.TP
.B 13
-\- Can't open input file
-.br
+Can\(aqt open input file
+.TP
.B 19
-\- Error writing to ATR image, \fBor\fR trailing junk in the input image
-.br
+Error writing to ATR image, or trailing junk in the input image
+.TP
.B 20
-\- Input file is not an Atari executable (missing 0xFF 0xFF signature)
-.br
-.PP
-\fBunmakatr\fR reports "Error #0" for any and all errors it may encounter.
-.PP
-Both \fBmakeatr\fR and \fBunmakatr\fR return a 0 exit status to the caller
-for success, or non-zero status for failure (and print one of the above
-error messages, as well). Error messages are printed to standard \fBoutput\fR,
-not standard error output.
-
+Input file is not an Atari executable (missing 0xFF 0xFF signature)
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+Error messages are printed to standard output, not standard error output.
+.SH EXIT STATUS
+.sp
+Exit status is 0 for success, or non\-zero status for failure.
+.SH COPYRIGHT
+.sp
+Copyright 1997, Ken Siders.
.SH AUTHOR
-Ken Siders <\fBatari8bit@columbus.rr.com\fR>
-.PP
-Man page by B. Watson <\fBurchlay@urchlay.com\fR>
-
+.sp
+Ken Siders was the original author of this utility.
+.sp
+Man page and Linux port done by B. Watson <\fI\%urchlay@slackware.uk\fP>;
+Urchlay on irc.libera.chat \fI##atari\fP\&.
.SH SEE ALSO
-\&\fIatrdir\fR\|(1), \&\fIatrextr\fR\|(1), \&\fIsortatr\fR\|(1).
-.PP
-Ken Siders Atari 8-bit page:
-.br
-http://atari.ksiders.tzo.com/a8emulators.html
+.sp
+\fBatrdir\fP(1),
+\fBatrextr\fP(1),
+\fBmakeatr\fP(1),
+\fBsortatr\fP(1).
+.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.
+.
diff --git a/ksiders/makeatr.rst b/ksiders/makeatr.rst
new file mode 100644
index 0000000..d6d1691
--- /dev/null
+++ b/ksiders/makeatr.rst
@@ -0,0 +1,81 @@
+=======
+makeatr
+=======
+
+-------------------------------------------------------
+convert an Atari executable to a "K-file" bootable disk
+-------------------------------------------------------
+
+.. include:: manhdr.rst
+
+SYNOPSIS
+========
+makeatr *imagefile.atr* *atari-executable*
+
+DESCRIPTION
+===========
+
+For various reasons, it's sometimes useful to make a bootable disk
+image of an Atari executable. **makeatr** does exactly that.
+
+If you have a bootable image made with **makeatr**, but you've lost
+the original executable, you can extract it from the image with
+**unmakatr**\(1).
+
+NOTES
+=====
+
+**makeatr** is only useful for single-file games or other programs
+that don't need DOS disk access to run: the bootable image
+won't contain any DOS at all, or even a DOS file structure
+(you can't read the directory).
+
+Disks made with **makeatr** are recognizable when booted on the Atari,
+because they display a GRAPHICS 0 screen with a lowercase k (screen
+is otherwise blank).
+
+Disk images made with **makeatr** are only created with enough sectors
+to hold the executable. AtariSIO can handle these images fine, as can
+most other ATR utilities, but the smaller-than-regulation size may
+cause problems with some utilities.
+
+There is only one Atari executable format, regardless of filename
+extension. All .XEX, .COM, .BIN, .EXE, etc. files for the Atari are
+the same file type, regardless of the name, and regardless of what
+you may have read on some forum site. Atari DOS doesn't care about
+the filename; it only exists for human consumption (and for filetype
+association with emulators, these days).
+
+DIAGNOSTICS
+===========
+
+**makeatr**'s error messages are not well documented. They consist only
+of an internal error number code, listed here:
+
+ 1
+ Unable to open ATR image for writing
+ 2
+ Unable to write image ATR header
+ 6
+ Unable to write boot sectors to ATR image
+ 7
+ Error while padding ATR image to an even sector size
+ 11
+ Unable to stat the input file (not found, permission denied, etc)
+ 12
+ Input file is 0 bytes in length
+ 13
+ Can't open input file
+ 19
+ Error writing to ATR image, or trailing junk in the input image
+ 20
+ Input file is not an Atari executable (missing 0xFF 0xFF signature)
+
+Error messages are printed to standard output, not standard error output.
+
+EXIT STATUS
+===========
+
+Exit status is 0 for success, or non-zero status for failure.
+
+.. include:: manftr.rst
diff --git a/ksiders/unmakatr.1 b/ksiders/unmakatr.1
new file mode 100644
index 0000000..ca8e6e6
--- /dev/null
+++ b/ksiders/unmakatr.1
@@ -0,0 +1,70 @@
+.\" 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 "UNMAKATR" 1 "2024-05-10" "0.9.0" "Ken Siders' Atari 8-bit Tools"
+.SH NAME
+unmakatr \- convert a "K-file" bootable disk to an Atari 8-bit executable
+.SH SYNOPSIS
+.sp
+unmakatr \fIimagefile.atr\fP \fIatari\-executable\fP
+.SH DESCRIPTION
+.sp
+If you have a bootable image made with \fBmakeatr\fP(1), but you\(aqve
+lost the original executable, you can extract it from the image with
+\fBunmakatr\fP\&.
+.sp
+\fBunmakatr\fP only works for images created by \fBmakeatr\fP, so\-called
+K\-File disks. It is not a general\-purpose bootdisk\-to\-executable
+converter.
+.SH DIAGNOSTICS
+.sp
+\fBunmakatr\fP reports "Error #0" for any and all errors it may encounter.
+.SH EXIT STATUS
+.sp
+Exit status is 0 for success, or non\-zero status for failure.
+.SH COPYRIGHT
+.sp
+Copyright 1997, Ken Siders.
+.SH AUTHOR
+.sp
+Ken Siders was the original author of this utility.
+.sp
+Man page and Linux port done by B. Watson <\fI\%urchlay@slackware.uk\fP>;
+Urchlay on irc.libera.chat \fI##atari\fP\&.
+.SH SEE ALSO
+.sp
+\fBatrdir\fP(1),
+\fBatrextr\fP(1),
+\fBmakeatr\fP(1),
+\fBsortatr\fP(1).
+.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.
+.
diff --git a/ksiders/unmakatr.rst b/ksiders/unmakatr.rst
new file mode 100644
index 0000000..2d4b9ca
--- /dev/null
+++ b/ksiders/unmakatr.rst
@@ -0,0 +1,36 @@
+========
+unmakatr
+========
+
+-------------------------------------------------------------
+convert a "K-file" bootable disk to an Atari 8-bit executable
+-------------------------------------------------------------
+
+.. include:: manhdr.rst
+
+SYNOPSIS
+========
+unmakatr *imagefile.atr* *atari-executable*
+
+DESCRIPTION
+===========
+
+If you have a bootable image made with **makeatr**\(1), but you've
+lost the original executable, you can extract it from the image with
+**unmakatr**.
+
+**unmakatr** only works for images created by **makeatr**, so-called
+K-File disks. It is not a general-purpose bootdisk-to-executable
+converter.
+
+DIAGNOSTICS
+===========
+
+**unmakatr** reports "Error #0" for any and all errors it may encounter.
+
+EXIT STATUS
+===========
+
+Exit status is 0 for success, or non-zero status for failure.
+
+.. include:: manftr.rst