aboutsummaryrefslogtreecommitdiff
path: root/a8xd.rst
diff options
context:
space:
mode:
Diffstat (limited to 'a8xd.rst')
-rw-r--r--a8xd.rst108
1 files changed, 108 insertions, 0 deletions
diff --git a/a8xd.rst b/a8xd.rst
new file mode 100644
index 0000000..9d6d00d
--- /dev/null
+++ b/a8xd.rst
@@ -0,0 +1,108 @@
+====
+a8xd
+====
+
+--------------------------
+Atari ASCII aware hex dump
+--------------------------
+
+.. include:: manhdr.rst
+
+SYNOPSIS
+========
+
+*a8xd* [**-i**] [**-m**] [**-v**] [*infile*]
+
+DESCRIPTION
+===========
+
+**a8xd** is a hex dump utility, similar to **xxd**\(1), but it
+understands and prints ATASCII characters rather than ASCII.
+
+The ATASCII codes are converted to UTF-8, in the same way as
+**a8cat**\(1). Codes with the high bit set are displayed in inverse
+video, using ANSI/VT-100 escape sequences.
+
+By default, the output is colorized:
+
+ - Normal characters are green. This includes alphanumerics, spaces, and
+ punctuation.
+
+ - Codes **$00** (null, or ATASCII heart) and **$9B** (EOL) are red.
+
+ - Control characters are yellow. This includes codes **$01** to **$1F**,
+ (control + letters, escape, punctuation, and arrow keys), **$60**, **$7B**, **$7D**
+ (clear screen), **$7E** (backspace), and **$7F** (tab).
+
+The colors and inverse rendering apply to both the ATASCII and hex bytes.
+
+Without *infile*, or if *infile* is **-**, **a8xd** reads from standard input.
+
+OPTIONS
+=======
+
+Options marked with **\*** are not yet implemented.
+
+-i
+ Print XL/XE International Character Set conversions instead of ATASCII.
+
+-l *len*
+ Stop after dumping *len* bytes. *len* may be given in decimal or hex (with
+ leading *0x* or *$*).
+
+-m
+ Monochrome mode. Disables color, but ATASCII characters with the high bit
+ set are still displayed in inverse.
+
+-n
+ **\*** Narrow dump mode. Displays 8 bytes per line. Maximum line length is
+ less than 40 columns. Use this if your terminal is less than 75 columns
+ wide.
+
+-o *offset*
+ **\*** Add *offset* to displayed file position. *offset* can be given in decimal
+ or hex (with leading *0x* or *$*).
+
+-s *[-]seek*
+ **\*** Start at *seek* bytes. Without *-*, this is an absolute offset. With *-*,
+ it's relative to the end of the file. The *-* option won't work when
+ reading from standard input. *seek* may be given in decimal or hex
+ (with leading *0x* or *$*).
+
+-u
+ **\*** Use uppercase letters; the default is lowercase.
+
+-v
+ Verbose. Currently, this option is accepted, but it doesn't do anything yet.
+
+**--**
+ End of options; the nex argument is the filename. Use this if you're
+ trying to work with files whose names begin with *-*.
+
+**-h**, **--help**
+ Show built-in help and exit.
+
+**--version**
+ Show version number and exit.
+
+NOTES
+=====
+
+**a8xd** supports a useful subset of **xxd**\(1) options. The main things
+missing are:
+
+- **-r** (revert).
+
+- **-include** (output as C include) and all options related to it.
+
+- **-g** (grouping; **a8xd** always uses a group size of 1 byte).
+
+- **-E** (EBCDIC mode).
+
+- **-p** (PostScript/continuous dump).
+
+- **-cols** (**a8xd** only supports 8 or 16 column dumps).
+
+- **-b** (bits mode).
+
+.. include:: manftr.rst