aboutsummaryrefslogtreecommitdiff
path: root/blob2xex.rst
diff options
context:
space:
mode:
authorB. Watson <urchlay@slackware.uk>2024-04-24 09:32:49 -0400
committerB. Watson <urchlay@slackware.uk>2024-04-24 09:32:49 -0400
commit53a0578bd0605cfa39e7d8d126aa78fb216527d3 (patch)
treee767725d157ea9401efe95c34b0ea82f4e3e1dcd /blob2xex.rst
parent140ced429cba74084d65942840b1f97fc77d8d9b (diff)
downloadbw-atari8-tools-53a0578bd0605cfa39e7d8d126aa78fb216527d3.tar.gz
Stub and man page for new blob2xex utility.
Diffstat (limited to 'blob2xex.rst')
-rw-r--r--blob2xex.rst62
1 files changed, 62 insertions, 0 deletions
diff --git a/blob2xex.rst b/blob2xex.rst
new file mode 100644
index 0000000..bbf0e0f
--- /dev/null
+++ b/blob2xex.rst
@@ -0,0 +1,62 @@
+.. RST source for blob2xex(1) man page. Convert with:
+.. rst2man.py blob2xex.rst > blob2xex.1
+
+========
+blob2xex
+========
+
+--------------------------------------------------
+Create Atari 8-bit executables from arbitrary data
+--------------------------------------------------
+
+.. include:: manhdr.rst
+
+SYNOPSIS
+========
+
+blob2xex [**-l** *loadaddr* [**-r** *runaddr*] [**-i** *initaddr*] [**-o** *offset*] [**-s** *size*] *infile*] ... *outfile*
+
+DESCRIPTION
+===========
+
+**blob2xex** creates an Atari 8-bit binary load (xex) file from one or
+more files of arbitrary data.
+
+Each input file *requires* a **-l** *loadaddr* option, to set the load
+address. Optionally, run and init addresses can be included. Also,
+using **-o** and **-s**, it's possible to include only part of the
+input file. To read from standard input, use **-** for the *infile*.
+
+Only one *outfile* is supported. When multiple input files are used,
+the resulting .xex file will have multiple segments. Use **-** to
+write to standard output.
+
+Addresses, offsets, and sizes may be given in decimal or hex. Hex
+addresses must be prefixed with either **$** or **0x**.
+
+OPTIONS
+=======
+
+-l *loadaddr*
+ Set the load address of the next *infile*. Each *infile* must be preceded by
+ a **-l** option.
+
+-r *runaddr*
+ Optional; set the run address. Since a .xex file can only have one run address,
+ the last **-r** option will be the one used when the file is loaded on the Atari.
+
+-i *initaddr*
+ Optional; set an init address, to be executed after the next segment loads.
+
+-o *offset*
+ Optional; skip this many bytes of the next input file. Default is **0**.
+
+-s *size*
+ Optional; read this many bytes of the next input file. Default is the entire file.
+
+EXAMPLES
+========
+
+TODO: come up with a few examples.
+
+.. include:: manftr.rst