.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Podwrapper::Man 1.48.1 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "nbdkit_debug_hexdump 3"
.TH nbdkit_debug_hexdump 3 2026-10-05 nbdkit-1.48.1 NBDKIT
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
nbdkit_debug_hexdump,
nbdkit_debug_hexdiff \- display buffer in hexdump format
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& #include <nbdkit\-plugin.h>
\&
\& void nbdkit_debug_hexdump (const void *buf, size_t len,
\&                            const char *prefix, uint64_t start);
\&
\& void nbdkit_debug_hexdiff (const void *buf1, const void *buf2,
\&                            size_t len,
\&                            const char *prefix, uint64_t start);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBnbdkit_debug_hexdump\fR displays a buffer of binary data in canonical
hexdump format, sending the output to the same place as
\&\fBnbdkit_debug\fR\|(3).  For example:
.PP
.Vb 2
\& char buf[33] = "12345678123456781234567812345678";
\& nbdkit_debug_hexdump (buf, 32, "data: ", 0);
.Ve
.PP
would produce output similar to this:
.PP
.Vb 2
\& data: 00000000: 31 32 33 34 35 36 37 38  31 32 33 34 35 36 37 38  |1234567812345678|
\& data: 00000010: 31 32 33 34 35 36 37 38  31 32 33 34 35 36 37 38  |1234567812345678|
.Ve
.PP
An optional \f(CW\*(C`prefix\*(C'\fR may be given which prefixes the string on each
line of output.  (This may be \f(CW\*(C`NULL\*(C'\fR or \f(CW""\fR for no prefix).
.PP
An optional \f(CW\*(C`start\*(C'\fR may be given which changes the first offset
displayed in the output.
.PP
\&\fBnbdkit_debug_hexdiff\fR displays the differences between two binary
buffers (of the same length).
.PP
For rows which are the same in both buffers, the output is the same as
above.  For rows which are different it shows the first buffer in the
first row (prefixed with \f(CW\*(C`\-\*(C'\fR) and the differences in the second
buffer in the second row (prefixed with \f(CW\*(C`+\*(C'\fR):
.PP
.Vb 2
\& \-00000000: 31 32 33 34 35 36 37 38  31 32 33 34 35 36 37 38  |1234567812345678|
\& +00000000:                          39 38 37 36    34 33 32  |        9876 432|
.Ve
.SH "LANGUAGE BINDINGS"
.IX Header "LANGUAGE BINDINGS"
In \fBnbdkit\-ocaml\-plugin\fR\|(3):
.PP
.Vb 3
\& NBDKit.debug_hexdump : NBDKit.buf \-> string option \-> int64 \-> unit
\& NBDKit.debug_hexdiff : NBDKit.buf \-> NBDKit.buf \-> string option \->
\&                        int64 \-> unit
.Ve
.PP
In \fBnbdkit\-python\-plugin\fR\|(3):
.PP
.Vb 3
\& import nbdkit
\& nbdkit.debug_hexdump(bytes, prefix, start)
\& nbdkit.debug_hexdiff(bytes, bytes, prefix, start)
.Ve
.PP
In \fBnbdkit\-rust\-plugin\fR\|(3):
.PP
.Vb 3
\& use nbdkit::*;
\& debug_hexdump(buf, prefix, start);
\& debug_hexdiff(buf1, buf2, prefix, start);
.Ve
.SH HISTORY
.IX Header "HISTORY"
\&\f(CW\*(C`nbdkit_debug_hexdump\*(C'\fR was added in nbdkit 1.46.
.PP
\&\f(CW\*(C`nbdkit_debug_hexdiff\*(C'\fR was added in nbdkit 1.48.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBnbdkit\fR\|(1),
\&\fBnbdkit_debug\fR\|(3),
\&\fBnbdkit\-plugin\fR\|(3),
\&\fBnbdkit\-filter\fR\|(3),
\&\fBnbdkit\-checkwrite\-filter\fR\|(1),
\&\fBnbdkit\-evil\-filter\fR\|(1),
\&\fBnbddump\fR\|(1),
\&\fBhexdump\fR\|(1).
.SH AUTHORS
.IX Header "AUTHORS"
Richard W.M. Jones
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright Red Hat
.SH LICENSE
.IX Header "LICENSE"
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
.IP \(bu 4
Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
.IP \(bu 4
Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
.IP \(bu 4
Neither the name of Red Hat nor the names of its contributors may be
used to endorse or promote products derived from this software without
specific prior written permission.
.PP
THIS SOFTWARE IS PROVIDED BY RED HAT AND CONTRIBUTORS \*(Aq\*(AqAS IS\*(Aq\*(Aq AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RED HAT OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.