eksd/README.md
Jaidyn Ann 58aedf06c0 Update README
Tweaking line-breaks, and mentioning the tests.
2024-05-27 23:33:35 -05:00

3.0 KiB
Raw Permalink Blame History

EKSD

xxd is a very good hexdump program that makes editing files on UNIX very easy. It also doesn't support text-tables. Which sucks.

eksd is a clone of a good hexdump program (even matching several arguments exactly)… except it supports text-tables.

Usage

To see a hexdump of a file, just run:

$ eksd $FILE > $HEXDUMP_FILE

If you want to turn a hexdump (from eksd or xxd) back to a file:

$ eksd -r $HEXDUMP_FILE > $FILE

And to make a hexdump with a custom text-table:

$ eksd -t $TABLE_FILE $FILE > $HEXDUMP_FILE

Text-tables are in a simple format— one hexcode per line, followed by its character. See ./text_tables/* for examples.

By default, eksd uses a built-in fancy text-table— it's basic ASCII, except it'll print nice pictographics for newline characters, etc. These require UTF, of course. If they don't work for you, use the "-a" arg to revert to simple, non-fancy ASCII. Note that specifying a text-table will override "-a", though.

Examples

Here's a part of Castlevania (EU) for the NES using its text-table:

$ eksd -t castle-table.txt castlevania.nes  | grep -A4 "18e80"
00018e80: 5454 5454 866e 6854 6460 8486 5454 5454  ....THE.CAST....
00018e90: 5454 5454 5466 8260 6488 7660 5454 5454  .....DRACULA....
00018ea0: 5464 6e82 7084 867c 7e6e 6882 5462 6868  .CHRISTOPHER.BEE
00018eb0: 5454 5454 5454 6668 6086 6e54 5454 5454  ......DEATH.....
00018ec0: 5454 5462 6876 7c54 7688 6c7c 8470 5454  ...BELO.LUGOSI..

And here's that same file in Vims xxd (just because I feel like showing off):

$ xxd castlevania.nes | grep -A4 "18e80"
00018e80: 5454 5454 866e 6854 6460 8486 5454 5454  TTTT.nhTd`..TTTT
00018e90: 5454 5454 5466 8260 6488 7660 5454 5454  TTTTTf.`d.v`TTTT
00018ea0: 5464 6e82 7084 867c 7e6e 6882 5462 6868  Tdn.p..|~nh.Tbhh
00018eb0: 5454 5454 5454 6668 6086 6e54 5454 5454  TTTTTTfh`.nTTTTT
00018ec0: 5454 5462 6876 7c54 7688 6c7c 8470 5454  TTTbhv|Tv.l|.pTT

Installation

Making a binary requires an implementation of Common Lisp installed: Steel Bank Common Lisp is our implementation-of-choice. Its available on most operating systems under the package name sbcl.

You also need the library-manager Quicklisp, which can be installed quite easily, including via our Makefile.

To install Quicklisp, build a binary, and install it, simply:

$ make quicklisp
$ make build
$ sudo cp eksd /usr/local/bin/eksd

Bam, you've made and installed a binary! Cool!

Tests

eksds tests can be run from a REPL using ASDF:TEST-SYSTEM, or from the Makefile target “test”.

* (asdf:test-system :eksd)
* (asdf:test-system :eksd/unix)
`$ make test

Misc