Repository files navigation

This is the well-known hex-dump-type utilityxxd commonly distributedas a part of thevim-project.The version ofxxd in this repository has been adaptedfor MSVC/GCC/clang standalone build.

Occasional releases and build artifacts consisting of the executablexxd programare created for Windows, LINUX and MacOS . These can be readily foundon the repo front page and in CI workflow-run download-areasfor immediate client use.

Using released or CI-built artifacts can be convenient when youdo not actually want to nor need to manually buildckormanyos/xxd.

Buildingckormanyos/xxd (if needed) is straightforward.

The source code inckormanyos/xxd has been adaptedfor standalone build on most common operating systems.

The source code ofckormanyos/xxd is written in the C language.It is compatible with language standards C99, 11, 17, 23 and beyond.

On Windows with MSVC simply buildckormanyos/xxd with the following.

• Open thexxd.sln workspace.
• RebuildRelease (i.e., for thex64 project configuration).
• After building, find the executablexxd.exe in the expected output directory.

On LINUX it is straightforward to buildckormanyos/xxd on the command line.

• Switch to thexxddirectory.
• Build (for instance with GCC) using an easy command, as shown below.
• This compilessrc/xxd.c toxxd.

In other words,

cd xxdg++ -x c -std=c17 -O2 -Wall -Wextra -Wpedantic -Wconversion -Wsign-conversion src/xxd.c -o xxd

When on MacOS, it is also easy to buildckormanyos/xxd on the command line.

• Switch to thexxddirectory.
• Build (for instance with clang) using an easy command, as shown below.
• This compilessrc/xxd.c toxxd.

In other words,

cd xxdclang++ -x c -std=c17 -O2 -Wall -Wextra -Wpedantic -Wconversion -Wsign-conversion src/xxd.c -o xxd

Buildingckormanyos/xxd on the command line is also supportedwith platform-independent CMake (and ninja).This has been motivated byissue 16.

cd xxdmkdir buildcd buildcmake .. -G Ninja&& ninja

The following adaptions have been undertaken.

• Create an MSVC*.sln workspace and associated project configuration.
• Disregard (i.e., delete and do not use) the configuration headerconfig.h.in.
• Replace the compiler switchWIN32 with MSVC's standard_WIN32.
• Run thexxd.c/config.h files through theArtistic Style automatic code formatter, using a version ofAStyle from somewhere around 2015.
• Handle Level-3 warnings found in MSVC.
• Handle GCC warnings from-Wall,-Wextra,-Wpedantic,-Wconversion and-Wsign-conversion.
• Add CI consisting of MSVC/GCC/clang builds and a handful of straightforward test cases.
• Upload build artifacts in CI forxxd-x86_64-linux-gnu andxxd-win64-msvc, see also discussion inissue 11.
• Resolve code-technical issues (and/or disable some) found via quality checks performed with CodeSonar, as described inissue 15 andissue 23.
• Implementation of the-n flag, as seen invim/vim@83e1180 and added inPR 45.
• Usefgetc()/fputc() instead ofgetc()/putc(). See alsoPR 50 which fixes a bug where sometimes line feeds0x0A (i.e.,\n) get an additional (unexpected) carriage return0x0D (i.e.,\r) - or sometimes even two - with them onWin* when reading/writing files.
• Employ shell scripts in combination withgcov,lcov (and locally)htmlgen to obtaincode coverage results in CI for this repo.

The program manual at thexxd(1) - Linux man pagestates:

xxd - make a hexdump or do the reverse.

It can do nearly everything hexdump can and moreover performthe reversal translation of hex-like text back to binary representation.Likeuuencodeanduudecodeit allows the transmission of binary data in amail-safeASCII representation, but has the advantage of decoding to standard output.Moreover, it can be used to perform binary file patching.

Print everything but the first three lines (hex 0x30 bytes) of file.

% xxd -s 0x30 file

Print 3 lines (hex 0x30 bytes) from the end of file.

% xxd -s -0x30 file

Print 120 bytes as continuous hexdump with 20 octets per line.

% xxd -l 120 -ps -c 20 xxd.12e5448205858442031202241756775737420313939362220224d616e75616c207061676520666f7220787864220a2e5c220a2e5c222032317374204d617920313939360a2e5c22204d616e207061676520617574686f723a0a2e5c2220202020546f6e79204e7567656e74203c746f6e79407363746e7567

Hexdump the first 120 bytes of this man page with 12 octets per line.

% xxd -l 120 -c 12 xxd.10000000: 2e54 4820 5858 4420 3120 2241  .TH XXD 1"A000000c: 7567 7573 7420 3139 3936 2220  ugust 1996"0000018: 224d 616e 7561 6c20 7061 6765"Manual page0000024: 2066 6f72 2078 7864 220a 2e5c   for xxd"..\0000030: 220a 2e5c 2220 3231 7374 204d"..\" 21st M000003c: 6179 2031 3939 360a 2e5c 2220  ay 1996..\"0000048: 4d61 6e20 7061 6765 2061 7574  Man page aut0000054: 686f 723a 0a2e 5c22 2020 2020  hor:..\"0000060: 546f 6e79 204e 7567 656e 7420  Tony Nugent000006c: 3c74 6f6e 7940 7363 746e 7567  <tony@sctnug

Display just the date from the file xxd.1

% xxd -s 0x36 -l 13 -c 13 xxd.10000036: 3231 7374 204d 6179 2031 3939 36  21st May 1996

Copy input_file to output_file and prepend 100 bytes of value 0x00.

% xxd input_file| xxd -r -s 100> output_file

Patch the date in the file xxd.1

%echo"0000037: 3574 68"| xxd -r - xxd.1% xxd -s 0x36 -l 13 -c 13 xxd.10000036: 3235 7468 204d 6179 2031 3939 36  25th May 1996

Create a 65537 byte file with all bytes 0x00, except for the last one which is 'A' (hex 0x41).

%echo"010000: 41"| xxd -r> file

Hexdump this file with autoskip.

% xxd -a -c 12 file0000000: 0000 0000 0000 0000 0000 0000  ............*000fffc: 0000 0000 40                   ....A

Create a 1 byte file containing a single 'A' character. The numberafter '-r -s' adds to the linenumbers found in the file; in effect, theleading bytes are suppressed.

%echo"010000: 41"| xxd -r -s -0x10000> file

Read single characters from a serial line

% xxd -c1< /dev/term/b&% stty< /dev/term/b -echo -opost -isig -icanon min 1%echo -n foo> /dev/term/b

Continuous integration (CI) runs with GCC, clang and MSVC with bothtool-specific builds as well as platform-independent CMake builds.CI exercises both buildingxxd as well as runningseveral straightforwardxxd test cases.

A (growing) test suite is present inxxd_tests.sh.These tests are used in CI to verify the expected functionality and alsoto obtaincode coverage results.

When searching for thexxd utility one finds it distributed as a part of vim-project and its packages.This project extracts the code, creates an MSVC solution workspace and providesthe ability to easily buildxxd onWin* or*nix.

The original code was taken from:vim github repo on 28-March-2022.The simplicity of the code port has been previously established (among other places)infancer/xxd.

Thexxd code copyrights are left untouchedexcept for adding an additional note regarding the MSVC build.The license as well as the license declaration are left untouched.This original package is licensed by GPL-2.0. This version retains compatibility with thelicensing of the original utility.

Other code parts (such as continuous integration scripts) are licensed under BSL 1.0.