Skip to content

Commit

Permalink
Update the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
xyproto committed Jan 17, 2024
1 parent 63937eb commit 8d42674
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ Tested on Arch Linux and macOS, where it builds, runs and all tests pass.

### What is it, and what can it do?

The `xxd` utility is a command-line program widely used in Unix-like systems for creating a hexadecimal dump of a given binary file. Essentially, it converts binary data into a human-readable hexadecimal format, often for the purpose of debugging or examining the underlying data structure of files. It displays each byte of the input data as a two-digit hexadecimal number, often accompanied by its ASCII equivalent, if printable. Additionally, `xxd` can reverse the process, taking a hexadecimal dump and converting it back into binary.
`xxd` or `tinyxxd` can be used to view binary or text files as hex codes. It is often installed on UNIX-like systems. It can dump files to hex, and also do the same thing in reverse: create files from hex codes.

It is sometimes used when building or packaging software.

`tinyxxd` is a drop-in replacement for `xxd` and contains the exact same logic, except that support for ie. Cygwin or VMS is not included.

### General info

Expand Down

0 comments on commit 8d42674

Please sign in to comment.