path: root/blob2xex.1

.\" 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 "BLOB2XEX" 1 "2024-07-02" "0.2.1" "Urchlay's Atari 8-bit Tools"
.SH NAME
blob2xex \- Create Atari 8-bit executables from arbitrary data
.\" RST source for blob2xex(1) man page. Convert with:
.
.\" rst2man.py blob2xex.rst > blob2xex.1
.
.SH SYNOPSIS
.sp
blob2xex \fIoutfile\fP [\fB\-v\fP] [\fB\-r\fP \fIrunaddr\fP] [\fB\-l\fP \fIloadaddr\fP [\fB\-i\fP \fIinitaddr\fP] [\fB\-o\fP \fIoffset\fP] [\fB\-s\fP \fIsize\fP] \fIinfile\fP] ...
.SH DESCRIPTION
.sp
\fBblob2xex\fP creates an Atari 8\-bit binary load (xex) file from one or
more files of arbitrary data. Each input file will become a separate
segment in the binary load file. A run address can be added with the
\fB\-r\fP option.
.sp
The first input file \fIrequires\fP a \fB\-l\fP \fIloadaddr\fP option, to set the
load address. Further input files can have their load addresses set
with \fB\-l\fP, also. If an input file lacks a load address, it will
load at the next address after the previous file\(aqs ending address.
.sp
Optionally, init addresses can be included, per\-segment
(\fB\-i\fP). Also, using \fB\-o\fP and \fB\-s\fP, it\(aqs possible to include only
part of the input file. To read from standard input, use \fB\-\fP for the
\fIinfile\fP\&.
.sp
\fIoutfile\fP must be given as the first argument. When multiple
input files are used, the resulting .xex file will have multiple
segments. If \fIoutfile\fP already exists, it will be \fIoverwritten\fP
(or \fIdeleted\fP, in case of error). Use \fB\-\fP to write to standard
output. \fBblob2xex\fP will not write output to a terminal; \fB\-\fP must
be used with redirection or a pipe.
.sp
If \fIoutfile\fP or any \fIinfile\fP is a filename that begins with a \fB\-\fP,
prefix it with "./", otherwise it\(aqll be taken as an option. The GNU
style \fB\-\-\fP (end of options) isn\(aqt implemented because it doesn\(aqt
make sense here. How often do you really use \fB\-\fP at the start of a
filename, anyway?
.sp
Addresses, offsets, and sizes may be given in decimal or hex. Hex
addresses must be prefixed with either \fB$\fP or \fB0x\fP\&.
.sp
It\(aqs impossible to create a segment that would wrap around the Atari\(aqs
64KB address space. Once address \fB$FFFF\fP is reached, no more data is
read from the input file.
.SH OPTIONS
.sp
A space is required between an option and its argument; use e.g. \fB\-l 0x2000\fP,
not \fB\-l0x2000\fP\&.
.INDENT 0.0
.TP
.B \-l \fIloadaddr\fP
Required; set the load address of the next \fIinfile\fP\&. The first \fIinfile\fP
\fBmust\fP be preceded by a \fB\-l\fP option; it\(aqs optional for the 2nd and
further files.
.TP
.B \-r \fIrunaddr\fP
Optional; set the run address. Default is no run address. Since a
\&.xex file can only have one run address, there\(aqs no point in giving
multiple \fB\-r\fP options. If you do, the last one will be used. This
option should be first on the command line (right after \fIoutfile\fP),
or at least must occur before any \fIinfile\fP\&.
.TP
.B \-i \fIinitaddr\fP
Optional; set an init address, to be executed after the next segment loads.
Default is no init address.
.TP
.B \-o \fIoffset\fP
Optional; skip this many bytes of the next input file. Default is \fB0\fP\&.
See the \fBMore Complex Example\fP below.
.TP
.B \-s \fIsize\fP
Optional; read this many bytes of the next input file. Default is the entire file,
or \fB0xffff\fP (\fB65535\fP) if the file is longer than 64KB. It\(aqs not an error
for \fIsize\fP to be larger than the file (reading will stop at EOF). Also, the
file\(aqs data will be truncated at Atari address \fB$FFFF\fP, regardless of
\fIsize\fP or the size of the file.
.UNINDENT
.INDENT 0.0
.TP
.B  \-v
Verbose output.
.TP
.B  \-h\fP,\fB  \-\-help
Print usage message and exit.
.TP
.B  \-V\fP,\fB  \-\-version
Print version number and exit.
.UNINDENT
.SH DIAGNOSTICS
.sp
Error messages and warnings are printed to standard error, and are
hopefully self\-explanatory. Any message containing \fIfatal\fP causes
\fBblob2xex\fP to exit with nonzero status, without creating the output
file.
.sp
Messages containing \fIwarning\fP are non\-fatal, and the output file is
created. There are only a few possible warnings:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B start/end address XXXX loads into ROM.
This means your .xex file\(aqs start/end addresses will load the
file into ROM (or the unmapped area at \fB$C000\fP on a 400/800).
Normally this means the .xex file won\(aqt load properly on the
Atari, but feel free to ignore this warning if you know exactly
what you\(aqre doing. Example: if your .xex file is intended to
be loaded on an 800 with an Axlon memory upgrade, mapped at
\fB$C000\fP, this warning can be ignored.
.TP
.B extra arguments after last input file ignored.
You gave at least one option that would affect the next file,
after the last file on the command line. Such options are ignored,
since there\(aqs no file for them to apply to. Probably you made
a typo or forgot the last input file.
.UNINDENT
.UNINDENT
.UNINDENT
.SH EXIT STATUS
.sp
Zero for success (the output file was created), even if there were
warnings. Non\-zero for failure (the output file wasn\(aqt created).
.SH EXAMPLES
.SS Simple Example
.sp
You\(aqve written an Atari 8\-bit program that loads at \fB$2000\fP, which
is also the run address. The assembler you used doesn\(aqt create Atari
\&.xex files, so you\(aqve got a \fBprogram.bin\fP that\(aqs just raw object
code. To turn it into a runnable .xex file, use:
.INDENT 0.0
.INDENT 3.5
blob2xex program.xex \-l \(aq$2000\(aq \-r \(aq$2000\(aq program.bin
.UNINDENT
.UNINDENT
.sp
Notice the use of quotes around the addresses? That\(aqs because the
$ character must be quoted, or the shell will try to interpret it
as a variable reference. You could also have typed \fB$2000\fP or
\fB0x2000\fP\&. Or you could have used decimal (\fB4096\fP).
.SS More Complex Example
.sp
Suppose you want to write a program that can run on an Atari 800,
but you want to use the International Character Set font from the
XL/XE machines. Also suppose that you have the XL ROM image as
\fIatarixl.rom\fP\&.
.sp
The way to use the XL ICS font on the 800 is to load it somewhere
in memory, on a 1K boundary. Suppose you\(aqve decided to load it at
\fB$8000\fP\&.
.sp
Any good reference book or other documentation on the Atari XL/XE
computers will tell you the ICS font is located at \fB$CC00\fP\&. The ROM
image starts at \fB$C000\fP (the start of XL/XE ROM), so the font is
located at offset \fB$0C00\fP within the ROM image. As always for Atari
fonts, it\(aqs 1KB, or \fB$0400\fP bytes.
.sp
So you can create a .xex file of the ROM font with:
.INDENT 0.0
.INDENT 3.5
blob2xex romfont.xex \-l 0x8000 \-o 0x0c00 \-s 0x0400 atarixl.rom
.UNINDENT
.UNINDENT
.sp
Since fonts aren\(aqt executable programs, there are no run (\fB\-r\fP) or
init (\fB\-i\fP) address options.
.sp
The resulting \fIromfont.xex\fP can be combined with the rest of your
program with \fBxexcat\fP(1).
.SH COPYRIGHT
.sp
WTFPL. See \fI\%http://www.wtfpl.net/txt/copying/\fP for details.
.SH AUTHOR
.INDENT 0.0
.IP B. 3
Watson <\fI\%urchlay@slackware.uk\fP>; Urchlay on irc.libera.chat \fI##atari\fP\&.
.UNINDENT
.SH SEE ALSO
.sp
\fBa8cat\fP(1),
\fBa8eol\fP(1),
\fBa8xd\fP(1),
\fBatr2xfd\fP(1),
\fBatrsize\fP(1),
\fBaxe\fP(1),
\fBblob2c\fP(1),
\fBblob2xex\fP(1),
\fBcart2xex\fP(1),
\fBcxrefbas\fP(1),
\fBdasm2atasm\fP(1),
\fBdumpbas\fP(1),
\fBf2toxex\fP(1),
\fBfenders\fP(1),
\fBlistbas\fP(1),
\fBprotbas\fP(1),
\fBrenumbas\fP(1),
\fBrom2cart\fP(1),
\fBunmac65\fP(1),
\fBunprotbas\fP(1),
\fBvxrefbas\fP(1),
\fBxex1to2\fP(1),
\fBxexamine\fP(1),
\fBxexcat\fP(1),
\fBxexsplit\fP(1),
\fBxfd2atr\fP(1),
\fBxex\fP(5),
\fBatascii\fP(7).
.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.
.