2008-07-01 22:30:57 +00:00
|
|
|
.\" -*- nroff -*-
|
|
|
|
|
.\"
|
|
|
|
|
.\" Copyright (c) 2003 Scott Long
|
|
|
|
|
.\"
|
|
|
|
|
.\" All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" This program is free software.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. 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.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' 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 THE DEVELOPERS 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.
|
|
|
|
|
.\"
|
|
|
|
|
.\" $FreeBSD$
|
|
|
|
|
.\"
|
2020-06-14 05:35:02 +00:00
|
|
|
.Dd May 8, 2020
|
2008-07-01 22:30:57 +00:00
|
|
|
.Dt HEXDUMP 3
|
2010-04-14 19:08:06 +00:00
|
|
|
.Os
|
2008-07-01 22:30:57 +00:00
|
|
|
.Sh NAME
|
|
|
|
|
.Nm hexdump
|
|
|
|
|
.Nd "dump a block of bytes to standard out in hexadecimal form"
|
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.In libutil.h
|
|
|
|
|
.Ft void
|
|
|
|
|
.Fn hexdump "void *ptr" "int length" "const char *hdr" "int flags"
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Fn hexdump
|
|
|
|
|
function prints an array of bytes to standard out in hexadecimal form,
|
2017-11-11 14:39:13 +00:00
|
|
|
along with the ASCII representation of the bytes, if possible.
|
|
|
|
|
By default, each line of output will start with an offset count, followed by 16
|
|
|
|
|
hexadecimal values, followed by 16 ASCII characters.
|
2008-07-01 22:30:57 +00:00
|
|
|
.Bl -tag -width indent
|
|
|
|
|
.It Fa ptr
|
|
|
|
|
Pointer to the array of bytes to print.
|
|
|
|
|
It does not need to be
|
|
|
|
|
.Dv NUL Ns
|
|
|
|
|
-terminated.
|
|
|
|
|
.It Fa length
|
|
|
|
|
Number of bytes to print.
|
|
|
|
|
.It Fa hdr
|
|
|
|
|
Pointer to a
|
|
|
|
|
.Dv NUL Ns
|
|
|
|
|
-terminated character string that will be prepended to each
|
|
|
|
|
line of output.
|
|
|
|
|
A value of
|
|
|
|
|
.Dv NULL
|
|
|
|
|
implies that no header will be printed.
|
|
|
|
|
.It Fa flags
|
|
|
|
|
Flags for controlling the formatting of the output.
|
|
|
|
|
.Bl -tag -width ".Dv HD_OMIT_COUNT"
|
|
|
|
|
.It Bits 0-7
|
|
|
|
|
Integer value of the number of bytes to display on each line.
|
|
|
|
|
A value of 0 implies that the default value of 16 will be used.
|
|
|
|
|
.It Bits 8-15
|
2017-11-11 14:39:13 +00:00
|
|
|
Character ASCII value to use as the separator for the hexadecimal output.
|
2008-07-01 22:30:57 +00:00
|
|
|
A value of 0 implies that the default value of 32
|
2017-11-11 14:39:13 +00:00
|
|
|
.Pq ASCII space
|
|
|
|
|
will be used.
|
2008-07-01 22:30:57 +00:00
|
|
|
.It Dv HD_OMIT_COUNT
|
|
|
|
|
Do not print the offset column at the beginning of each line.
|
|
|
|
|
.It Dv HD_OMIT_HEX
|
|
|
|
|
Do not print the hexadecimal values on each line.
|
|
|
|
|
.It Dv HD_OMIT_CHARS
|
|
|
|
|
Do not print the character values on each line.
|
|
|
|
|
.El
|
|
|
|
|
.El
|
|
|
|
|
.Sh SEE ALSO
|
Add support for reading MAM attributes to camcontrol(8) and libcam(3).
MAM is Medium Auxiliary Memory and is most commonly found as flash
chips on tapes.
This includes support for reading attributes and decoding most
known attributes, but does not yet include support for writing
attributes or reporting attributes in XML format.
libsbuf/Makefile:
Add subr_prf.c for the new sbuf_hexdump() function. This
function is essentially the same function.
libsbuf/Symbol.map:
Add a new shared library minor version, and include the
sbuf_hexdump() function.
libsbuf/Version.def:
Add version 1.4 of the libsbuf library.
libutil/hexdump.3:
Document sbuf_hexdump() alongside hexdump(3), since it is
essentially the same function.
camcontrol/Makefile:
Add attrib.c.
camcontrol/attrib.c:
Implementation of READ ATTRIBUTE support for camcontrol(8).
camcontrol/camcontrol.8:
Document the new 'camcontrol attrib' subcommand.
camcontrol/camcontrol.c:
Add the new 'camcontrol attrib' subcommand.
camcontrol/camcontrol.h:
Add a function prototype for scsiattrib().
share/man/man9/sbuf.9:
Document the existence of sbuf_hexdump() and point users to
the hexdump(3) man page for more details.
sys/cam/scsi/scsi_all.c:
Add a table of known attributes, text descriptions and
handler functions.
Add a new scsi_attrib_sbuf() function along with a number
of other related functions that help decode attributes.
scsi_attrib_ascii_sbuf() decodes ASCII format attributes.
scsi_attrib_int_sbuf() decodes binary format attributes, and
will pass them off to scsi_attrib_hexdump_sbuf() if they're
bigger than 8 bytes.
scsi_attrib_vendser_sbuf() decodes the vendor and drive
serial number attribute.
scsi_attrib_volcoh_sbuf() decodes the Volume Coherency
Information attribute that LTFS writes out.
sys/cam/scsi/scsi_all.h:
Add a number of attribute-related structure definitions and
other defines.
Add function prototypes for all of the functions added in
scsi_all.c.
sys/kern/subr_prf.c:
Add a new function, sbuf_hexdump(). This is the same as
the existing hexdump(9) function, except that it puts the
result in an sbuf.
This also changes subr_prf.c so that it can be compiled in
userland for includsion in libsbuf.
We should work to change this so that the kernel hexdump
implementation is a wrapper around sbuf_hexdump() with a
statically allocated sbuf with a drain. That will require
a drain function that goes to the kernel printf() buffer
that can take a non-NUL terminated string as input.
That is because an sbuf isn't NUL-terminated until it is
finished, and we don't want to finish it while we're still
using it.
We should also work to consolidate the userland hexdump and
kernel hexdump implemenatations, which are currently
separate. This would also mean making applications that
currently link in libutil link in libsbuf.
sys/sys/sbuf.h:
Add the prototype for sbuf_hexdump(), and add another copy
of the hexdump flag values if they aren't already defined.
Ideally the flags should be defined in one place but the
implemenation makes it difficult to do properly. (See
above.)
Sponsored by: Spectra Logic Corporation
MFC after: 1 week
2015-06-09 21:39:38 +00:00
|
|
|
.Xr ascii 7 ,
|
2017-03-21 19:10:07 +00:00
|
|
|
.Xr sbuf_hexdump 9
|
2020-06-14 05:35:02 +00:00
|
|
|
.Sh HISTORY
|
|
|
|
|
The
|
|
|
|
|
.Fn hexdump
|
|
|
|
|
function first appeared in
|
|
|
|
|
.Fx 6.4 .
|
2008-07-01 22:30:57 +00:00
|
|
|
.Sh AUTHORS
|
|
|
|
|
This manual page was written by
|
|
|
|
|
.An Scott Long .
|
