aboutsummaryrefslogtreecommitdiff
path: root/xexamine.rst
diff options
context:
space:
mode:
authorB. Watson <urchlay@slackware.uk>2024-04-25 14:52:52 -0400
committerB. Watson <urchlay@slackware.uk>2024-04-25 14:52:52 -0400
commit530b83e2736f1d4afeedd3bf99c8428da2adabf7 (patch)
tree0e2ef70beb8110ab08772031d42341e6197421a7 /xexamine.rst
parent6ff31c1205b46448918ee4e0f10b38ad4cc6746e (diff)
downloadbw-atari8-tools-530b83e2736f1d4afeedd3bf99c8428da2adabf7.tar.gz
xexamine: added.
Diffstat (limited to 'xexamine.rst')
-rw-r--r--xexamine.rst56
1 files changed, 56 insertions, 0 deletions
diff --git a/xexamine.rst b/xexamine.rst
new file mode 100644
index 0000000..a76ed16
--- /dev/null
+++ b/xexamine.rst
@@ -0,0 +1,56 @@
+.. RST source for xexamine(1) man page. Convert with:
+.. rst2man.py xexamine.rst > xexamine.1
+
+========
+xexamine
+========
+
+-------------------------------------------------
+Show information on Atari 8-bit executables (XEX)
+-------------------------------------------------
+
+.. include:: manhdr.rst
+
+SYNOPSIS
+========
+
+xexamine [ [**-h**] | [ [**-v**] *xexfile* ]
+
+DESCRIPTION
+===========
+
+**xexamine** reads an Atari 8-bit executable (.xex file) and prints
+the following information on each segment in the file:
+
+Segment number (1-based).
+
+Start and end addresses (in hex).
+
+Length in bytes (in decimal).
+
+CRC32 checksum of the segment.
+
+Segment type:
+
+ If the segment is a run address (loads at RUNAD) or an init address (loads at INITAD), the
+ type is "Run" or "Init", with the actual run or init address.
+
+ Otherwise, the percentage of the segment that contains valid 6502 object
+ code is printed. This is an estimate based on static analysis and some
+ heuristics, and as such, isn't 100% accurate.
+
+OPTIONS
+=======
+
+-h
+ Print a short help message and exit.
+
+-v
+ Verbose operation.
+
+EXIT STATUS
+===========
+
+Exit status is zero if *xexfile* is a valid Atari .xex file, non-zero otherwise.
+
+.. include:: manftr.rst