Interpreting hex viewer
Go to file
Přemysl Eric Janouch 6a6c7b2496
Fix SIGWINCH handling
2017-05-21 21:10:37 +02:00
liberty@084e964286 Bump liberty 2017-01-23 23:18:55 +01:00
plugins pcap.lua: fix decoding 2017-02-07 16:29:08 +01:00
termo@a9b41e41b7 Initial commit 2016-12-29 16:48:56 +01:00
.gitignore Initial commit 2016-12-29 16:48:56 +01:00
.gitmodules Initial commit 2016-12-29 16:48:56 +01:00
.travis.yml Travis CI: brevify notifications 2017-01-26 22:18:53 +01:00
CMakeLists.txt CMakeLists.txt: cleanup 2017-02-12 20:21:40 +01:00
LICENSE Fix and update LICENSE 2017-02-03 23:10:29 +01:00
README.adoc Update README 2017-02-05 18:49:13 +01:00
config.h.in Link to Lua 5.3 2017-01-17 14:13:57 +01:00
hex.c Fix SIGWINCH handling 2017-05-21 21:10:37 +02:00
hex.png Update the screenshot 2017-01-18 00:43:40 +01:00

README.adoc

hex

hex is yet another hex viewer. It automatically interprets fields within files using a set of Lua scripts, colorizing them and showing descriptions on the side.

At the moment there arent that many features and we only have a few decoders.

hex

Packages

Regular releases are sporadic. git master should be stable enough. You can get a package with the latest development version from Archlinuxs AUR, or from openSUSE Build Service for the rest of mainstream distributions. Consult the list of repositories and their respective links at:

Building and Running

Build dependencies: CMake, pkg-config, help2man, liberty (included), termo (included)
Runtime dependencies: ncursesw, libunistring, Lua >= 5.3 (for highlighting)

$ git clone --recursive https://github.com/pjanouch/hex.git
$ mkdir hex/build
$ cd hex/build
$ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug
$ make

To install the application, you can do either the usual:

# make install

Or you can try telling CMake to make a package for you. For Debian it is:

$ cpack -G DEB
# dpkg -i hex-*.deb

Note that for versions of CMake before 2.8.9, you need to prefix cpack with fakeroot or file ownership will end up wrong.

Having the program installed, optionally create a configuration file and run it on a file of your choice.

Configuration

Create ~/.config/hex/hex.conf with contents like the following:

colors = {
	footer     = ""
	footer_hl  = "bold"
	bar        = "reverse"
	bar_hl     = "reverse bold"
	even       = ""
	odd        = ""
	selection  = "reverse"
}

Terminal caveats

Terminals are somewhat tricky to get consistent results on, so be aware of the following:

  • Xterm needs XTerm*metaSendsEscape: true for the default bindings to work

  • urxvts 'vtwheel' plugin sabotages scrolling

Performance

While the Lua API has been made considerably easy to write new decoders with, the design is far from efficient as we make tons of new formatted strings. Since we need Lua 5.3 features (64-bit integers), LuaJIT cant help us here.

Similar software

Contributing and Support

Use this projects GitHub to report any bugs, request features, or submit pull requests. If you want to discuss this project, or maybe just hang out with the developer, feel free to join me at irc://irc.janouch.name, channel #dev.

License

hex is written by Přemysl Janouch <p.janouch@gmail.com>.

You may use the software under the terms of the ISC license, the text of which is included within the package, or, at your option, you may relicense the work under the MIT or the Modified BSD License, as listed at the following site: