Interpreting hex viewer
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Přemysl Eric Janouch 92902a4f76
CMakeLists.txt: declare compatibility with 3.27
Sadly, the 3.5 deprecation warning doesn't go away after this.
4 months ago
liberty@4c2874649d Bump liberty 5 months ago
plugins elf.lua: fix a typo 6 months ago
termo@8265f075b1 Bump liberty, termo 2 years ago
.clang-format Add clang-format configuration 2 years ago
.gitignore Update .gitignore 2 years ago
.gitmodules Bump liberty, termo 6 years ago
CMakeLists.txt CMakeLists.txt: declare compatibility with 3.27 4 months ago
LICENSE Bump liberty, move the UI to liberty-xui.c 6 months ago
README.adoc README.adoc: update package information 5 months ago
config.h.in Bump liberty, move the UI to liberty-xui.c 6 months ago
hex.adoc Bump liberty, move the UI to liberty-xui.c 6 months ago
hex.c g_ctx -> g 6 months ago
hex.desktop Bump liberty, move the UI to liberty-xui.c 6 months ago
hex.png Update screenshot 7 years ago

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. It also runs equally well in the terminal, or as an X11 client.

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 using Arch Linuxs AUR, or as a Nix derivation.

Documentation

See the man page for information about usage. The rest of this README will concern itself with externalities.

Building and Running

Build dependencies: CMake, pkg-config, awk, liberty (included), termo (included), asciidoctor or asciidoc (recommended but optional)
Runtime dependencies: ncursesw, libunistring, Lua >= 5.3 (for highlighting)
Optional runtime dependencies: x11, xft

$ git clone --recursive https://git.janouch.name/p/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

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

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 https://git.janouch.name/p/hex to report any bugs, request features, or submit pull requests. git send-email is tolerated. If you want to discuss the project, feel free to join me at ircs://irc.janouch.name, channel #dev.

Bitcoin donations are accepted at: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9

License

This software is released under the terms of the 0BSD license, the text of which is included within the package along with the list of authors.