xref: /freebsd/share/man/man9/hexdump.9 (revision a61f15043cb6d4574e5c0d1ac0f0157aaaaa7614)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 2003 Scott Long
4.\"
5.\" All rights reserved.
6.\"
7.\" This program is free software.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28.\"
29.\" $FreeBSD$
30.\"
31.Dd December 7, 2003
32.Os
33.Dt HEXDUMP 9
34.Sh NAME
35.Nm hexdump
36.Nd "Dump a block of bytes to the console in hexadecimal form"
37.Sh SYNOPSIS
38.In sys/systm.h
39.Ft void
40.Fn hexdump "void *ptr" "int length" "const char *hdr" "int flags"
41.Sh DESCRIPTION
42Hexdump prints an array of bytes to the console in hexadecimal form, along with
43the ASCII representation of the bytes, if possible.  By default, each line of
44output will start with an offset count, followed by 16 hexadecimal values,
45followed by 16 ASCII characters.
46.Bl -tag -width 6n
47.It Fa ptr
48Pointer to the array of bytes to print.  It does not need to be NULL-terminated.
49.It Fa length
50Number of bytes to print
51.It Fa hdr
52Pointer to a NULL-terminated character string that will be prepended to each
53line of output.  A value of NULL implies that no header will be printed.
54.It Fa flags
55Flags for controlling the formatting of the output
56.Bl -tag -width HD_OMIT_COUNT
57.It Fa Bits 0-7
58Integer value of the number of bytes to display on each line.  A value of 0
59implies that the default value of 16 will be used.
60.It Fa Bits 8-15
61Character ASCII value to use as the separator for the hexadecimal output.  A
62value of 0 implies that the default value of 32 (ASCII space) will be used.
63.It Fa HD_OMIT_COUNT
64Don't print the offset column at the beginning of each line
65.It Fa HD_OMIT_HEX
66Don't print the hexadecimal values on each line.
67.It Fa HD_OMIT_CHARS
68Don't print the character values on each line.
69.El
70.El
71.Pp
72.Sh SEE ALSO
73.Xr ascii 7
74.Sh AUTHORS
75This man page was written by
76.An Scott Long .
77