From 53a0578bd0605cfa39e7d8d126aa78fb216527d3 Mon Sep 17 00:00:00 2001 From: "B. Watson" Date: Wed, 24 Apr 2024 09:32:49 -0400 Subject: Stub and man page for new blob2xex utility. --- blob2xex.rst | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 blob2xex.rst (limited to 'blob2xex.rst') 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 -- cgit v1.2.3