https://github.com/jadedctrl/eksd
UNIX hexdumper that supports text-tables. An xxd clone. (🪞 Mirror)
https://github.com/jadedctrl/eksd
hex-dump hex-editor hex-editors text-table unix-command xxd
Last synced: 3 months ago
JSON representation
UNIX hexdumper that supports text-tables. An xxd clone. (🪞 Mirror)
- Host: GitHub
- URL: https://github.com/jadedctrl/eksd
- Owner: JadedCtrl
- License: gpl-3.0
- Created: 2019-11-19T05:41:39.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-02T19:15:44.000Z (4 months ago)
- Last Synced: 2025-03-02T20:25:15.960Z (4 months ago)
- Topics: hex-dump, hex-editor, hex-editors, text-table, unix-command, xxd
- Language: Common Lisp
- Homepage: https://hak.xwx.moe/jadedctrl/eksd
- Size: 183 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING.txt
Awesome Lists containing this project
README
# EKSD
[xxd](https://hg.256bit.org/vim/file/tip/src/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](https://hak.xwx.moe/jadedctrl/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/*](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 [Vim’s](https://www.vim.org) 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](https://common-lisp.net/implementations) of Common Lisp installed:
[Steel Bank Common Lisp](https://sbcl.org/) is our implementation-of-choice. It’s available on
most operating systems under the package name `sbcl`.
You also need the library-manager [Quicklisp](https://quicklisp.org), which can [be installed](https://www.quicklisp.org/beta/#installation)
quite easily, including via our [Makefile](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
eksd’s 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
* License is the GNU GPLv3 ([COPYING.txt](COPYING.txt))
* Author is Jaidyn Ann
* Sauce is at https://hak.xwx.moe/jadedctrl/eksd