aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorB. Watson <urchlay@slackware.uk>2024-04-25 02:11:23 -0400
committerB. Watson <urchlay@slackware.uk>2024-04-25 02:11:23 -0400
commitd545e77c56bbf394aa9ffb4561e1d8a30b769b60 (patch)
tree3436efac138dfebfbee975163e1b777c6241228f
parentc46d2c157f14121c3f844f5f438eefa559b2b92f (diff)
downloadbw-atari8-tools-d545e77c56bbf394aa9ffb4561e1d8a30b769b60.tar.gz
blob2xex: tweak doc.
-rw-r--r--blob2xex.124
-rw-r--r--blob2xex.rst26
2 files changed, 40 insertions, 10 deletions
diff --git a/blob2xex.1 b/blob2xex.1
index 757d68d..5858db2 100644
--- a/blob2xex.1
+++ b/blob2xex.1
@@ -52,11 +52,13 @@ part of the input file. To read from standard input, use \fB\-\fP for the
.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 overwritten.
-If \fIoutfile\fP is a filename that begins with a \fB\-\fP, prefix it with
-"./", otherwise it\(aqll be taken as an option. 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.
+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.
.sp
Addresses, offsets, and sizes may be given in decimal or hex. Hex
addresses must be prefixed with either \fB$\fP or \fB0x\fP\&.
@@ -95,6 +97,18 @@ Print usage message and exit.
.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 without creating the output file.
+.sp
+Messages containing \fIwarning\fP are non\-fatal, and the output file is
+created. The only warning messages are there to let you know if your
+\&.xex file\(aqs start/end addresses mean it would load 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 the
+warnings if you know exactly what you\(aqre doing.
.SH EXAMPLES
.SS Simple Example
.sp
diff --git a/blob2xex.rst b/blob2xex.rst
index 6bbbefc..9330445 100644
--- a/blob2xex.rst
+++ b/blob2xex.rst
@@ -32,11 +32,13 @@ part of the input file. To read from standard input, use **-** for the
*outfile* must be given as the first argument. When multiple
input files are used, the resulting .xex file will have multiple
-segments. If *outfile* already exists, it will be overwritten.
-If *outfile* is a filename that begins with a **-**, prefix it with
-"./", otherwise it'll be taken as an option. Use **-** to write to
-standard output. **blob2xex** will not write output to a terminal;
-**-** must be used with redirection or a pipe.
+segments. If *outfile* already exists, it will be *overwritten*
+(or *deleted*, in case of error). Use **-** to write to standard
+output. **blob2xex** will not write output to a terminal; **-** must
+be used with redirection or a pipe.
+
+If *outfile* or any *infile* is a filename that begins with a **-**,
+prefix it with "./", otherwise it'll be taken as an option.
Addresses, offsets, and sizes may be given in decimal or hex. Hex
addresses must be prefixed with either **$** or **0x**.
@@ -74,6 +76,20 @@ not **-l0x2000**.
-V, --version
Print version number and exit.
+DIAGNOSTICS
+===========
+
+Error messages and warnings are printed to standard error, and are
+hopefully self-explanatory. Any message containing *fatal* causes
+**blob2xex** to exit without creating the output file.
+
+Messages containing *warning* are non-fatal, and the output file is
+created. The only warning messages are there to let you know if your
+.xex file's start/end addresses mean it would load into ROM (or, the
+unmapped area at **$C000** on a 400/800). Normally this means the .xex
+file won't load properly on the Atari, but feel free to ignore the
+warnings if you know exactly what you're doing.
+
EXAMPLES
========