summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorscottl <scottl@FreeBSD.org>2003-12-07 20:48:00 +0000
committerscottl <scottl@FreeBSD.org>2003-12-07 20:48:00 +0000
commite9b8241ac79bbe4abe781d5d5fde761882ac90a1 (patch)
tree358ad2b71f58b4cf87e298dfc5efb850b2cd77fc
parent4b6eafd82fbafd73173a2b8ae6f21e80991de13c (diff)
downloadFreeBSD-src-e9b8241ac79bbe4abe781d5d5fde761882ac90a1.zip
FreeBSD-src-e9b8241ac79bbe4abe781d5d5fde761882ac90a1.tar.gz
Add a manual page for the consolidated debugging commit.
-rw-r--r--share/man/man9/Makefile1
-rw-r--r--share/man/man9/hexdump.976
2 files changed, 77 insertions, 0 deletions
diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index 503cac5..1334cac 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -49,6 +49,7 @@ MAN= BUF_LOCK.9 BUF_LOCKFREE.9 BUF_LOCKINIT.9 BUF_REFCNT.9 \
get_cyclecount.9 \
getnewvnode.9 \
groupmember.9 \
+ hexdump.9 \
ifnet.9 inittodr.9 intro.9 ithread.9 \
jumbo.9 \
kernacc.9 kobj.9 kthread.9 ktr.9 \
diff --git a/share/man/man9/hexdump.9 b/share/man/man9/hexdump.9
new file mode 100644
index 0000000..4170d4b
--- /dev/null
+++ b/share/man/man9/hexdump.9
@@ -0,0 +1,76 @@
+.\" -*- 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$
+.\"
+.Dd December 7, 2003
+.Os
+.Dt HEXDUMP 9
+.Sh NAME
+.Nm hexdump
+.Nd "Dump a block of bytes to the console in hexidecimal form"
+.Sh SYNOPSIS
+.In sys/systm.h
+.Ft void
+.Fn hexdump "void *ptr" "int length" "const char *hdr" "int flags"
+.Sh DESCRIPTION
+Hexdump prints an array of bytes to the console in hexidecimal form, 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 hexidecimal values,
+followed by 16 ASCII characters.
+.Bl -tag -width 6n
+.It Fa ptr
+Pointer to the array of bytes to print. It does not need to be NULL-terminated.
+.It Fa length
+Number of bytes to print
+.It Fa hdr
+Pointer to a NULL-terminated character string that will be prepended to each
+line of output. A value of NULL implies that no header will be printed.
+.It Fa flags
+Flags for controlling the formatting of the output
+.Bl -tag -width HD_OMIT_COUNT
+.It Fa 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 Fa Bits 8-15
+Character ASCII value to use as the separator for the hexidecimal output. A
+value of 0 implies that the default value of 32 (ASCII space) will be used.
+.It Fa HD_OMIT_COUNT
+Don't print the offset column at the beginning of each line
+.It Fa HD_OMIT_HEX
+Don't print the hexidecimal values on each line.
+.It Fa HD_OMIT_CHARS
+Don't print the character values on each line.
+.El
+.El
+.Pp
+.Sh SEE ALSO
+.Xr ascii 7
+.Sh AUTHORS
+This man page was written by
+.An Scott Long .
OpenPOWER on IntegriCloud