usr.bin/hexdump/hexdump.1

   1 .\" Copyright (c) 1989, 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)hexdump.1   8.2 (Berkeley) 4/18/94
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd June 29, 2020
  32 .Dt HEXDUMP 1
  33 .Os
  34 .Sh NAME
  35 .Nm hexdump , hd
  36 .Nd ASCII, decimal, hexadecimal, octal dump
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl bcCdovx
  40 .Op Fl e Ar format_string
  41 .Op Fl f Ar format_file
  42 .Op Fl n Ar length
  43 .Bk -words
  44 .Op Fl s Ar offset
  45 .Ek
  46 .Ar
  47 .Nm hd
  48 .Op Fl bcdovx
  49 .Op Fl e Ar format_string
  50 .Op Fl f Ar format_file
  51 .Op Fl n Ar length
  52 .Bk -words
  53 .Op Fl s Ar offset
  54 .Ek
  55 .Ar
  56 .Sh DESCRIPTION
  57 The
  58 .Nm
  59 utility is a filter which displays the specified files, or
  60 the standard input, if no files are specified, in a user specified
  61 format.
  62 .Pp
  63 The options are as follows:
  64 .Bl -tag -width indent
  65 .It Fl b
  66 .Em One-byte octal display .
  67 Display the input offset in hexadecimal, followed by sixteen
  68 space-separated, three column, zero-filled, bytes of input data,
  69 in octal, per line.
  70 .It Fl c
  71 .Em One-byte character display .
  72 Display the input offset in hexadecimal, followed by sixteen
  73 space-separated, three column, space-filled, characters of input
  74 data per line.
  75 .It Fl C
  76 .Em Canonical hex+ASCII display .
  77 Display the input offset in hexadecimal, followed by sixteen
  78 space-separated, two column, hexadecimal bytes, followed by the
  79 same sixteen bytes in %_p format enclosed in ``|'' characters.
  80 .Pp
  81 Calling the command
  82 .Nm hd
  83 implies this option.
  84 .It Fl d
  85 .Em Two-byte decimal display .
  86 Display the input offset in hexadecimal, followed by eight
  87 space-separated, five column, zero-filled, two-byte units
  88 of input data, in unsigned decimal, per line.
  89 .It Fl e Ar format_string
  90 Specify a format string to be used for displaying data.
  91 .It Fl f Ar format_file
  92 Specify a file that contains one or more newline separated format strings.
  93 Empty lines and lines whose first non-blank character is a hash mark
  94 .Pf ( Cm \&# )
  95 are ignored.
  96 .It Fl n Ar length
  97 Interpret only
  98 .Ar length
  99 bytes of input.
 100 .It Fl o
 101 .Em Two-byte octal display .
 102 Display the input offset in hexadecimal, followed by eight
 103 space-separated, six column, zero-filled, two byte quantities of
 104 input data, in octal, per line.
 105 .It Fl s Ar offset
 106 Skip
 107 .Ar offset
 108 bytes from the beginning of the input.
 109 By default,
 110 .Ar offset
 111 is interpreted as a decimal number.
 112 With a leading
 113 .Cm 0x
 114 or
 115 .Cm 0X ,
 116 .Ar offset
 117 is interpreted as a hexadecimal number,
 118 otherwise, with a leading
 119 .Cm 0 ,
 120 .Ar offset
 121 is interpreted as an octal number.
 122 Appending the character
 123 .Cm b ,
 124 .Cm k ,
 125 or
 126 .Cm m
 127 to
 128 .Ar offset
 129 causes it to be interpreted as a multiple of
 130 .Li 512 ,
 131 .Li 1024 ,
 132 or
 133 .Li 1048576 ,
 134 respectively.
 135 .It Fl v
 136 Cause
 137 .Nm
 138 to display all input data.
 139 Without the
 140 .Fl v
 141 option, any number of groups of output lines, which would be
 142 identical to the immediately preceding group of output lines (except
 143 for the input offsets), are replaced with a line comprised of a
 144 single asterisk.
 145 .It Fl x
 146 .Em Two-byte hexadecimal display .
 147 Display the input offset in hexadecimal, followed by eight, space
 148 separated, four column, zero-filled, two-byte quantities of input
 149 data, in hexadecimal, per line.
 150 .El
 151 .Pp
 152 For each input file,
 153 .Nm
 154 sequentially copies the input to standard output, transforming the
 155 data according to the format strings specified by the
 156 .Fl e
 157 and
 158 .Fl f
 159 options, in the order that they were specified.
 160 .Ss Formats
 161 A format string contains any number of format units, separated by
 162 whitespace.
 163 A format unit contains up to three items: an iteration count, a byte
 164 count, and a format.
 165 .Pp
 166 The iteration count is an optional positive integer, which defaults to
 167 one.
 168 Each format is applied iteration count times.
 169 .Pp
 170 The byte count is an optional positive integer.
 171 If specified it defines the number of bytes to be interpreted by
 172 each iteration of the format.
 173 .Pp
 174 If an iteration count and/or a byte count is specified, a single slash
 175 must be placed after the iteration count and/or before the byte count
 176 to disambiguate them.
 177 Any whitespace before or after the slash is ignored.
 178 .Pp
 179 The format is required and must be surrounded by double quote
 180 (" ") marks.
 181 It is interpreted as a fprintf-style format string (see
 182 .Xr fprintf 3 ) ,
 183 with the
 184 following exceptions:
 185 .Bl -bullet -offset indent
 186 .It
 187 An asterisk (*) may not be used as a field width or precision.
 188 .It
 189 A byte count or field precision
 190 .Em is
 191 required for each ``s'' conversion
 192 character (unlike the
 193 .Xr fprintf 3
 194 default which prints the entire string if the precision is unspecified).
 195 .It
 196 The conversion characters ``h'', ``l'', ``n'', ``p'' and ``q'' are
 197 not supported.
 198 .It
 199 The single character escape sequences
 200 described in the C standard are supported:
 201 .Bd -ragged -offset indent -compact
 202 .Bl -column <alert_character>
 203 .It "NUL        \e0"
 204 .It "<alert character>  \ea"
 205 .It "<backspace>        \eb"
 206 .It "<form-feed>        \ef"
 207 .It "<newline>  \en"
 208 .It "<carriage return>  \er"
 209 .It "<tab>      \et"
 210 .It "<vertical tab>     \ev"
 211 .El
 212 .Ed
 213 .El
 214 .Pp
 215 The
 216 .Nm
 217 utility also supports the following additional conversion strings:
 218 .Bl -tag -width Fl
 219 .It Cm \&_a Ns Op Cm dox
 220 Display the input offset, cumulative across input files, of the
 221 next byte to be displayed.
 222 The appended characters
 223 .Cm d ,
 224 .Cm o ,
 225 and
 226 .Cm x
 227 specify the display base
 228 as decimal, octal or hexadecimal respectively.
 229 .It Cm \&_A Ns Op Cm dox
 230 Identical to the
 231 .Cm \&_a
 232 conversion string except that it is only performed
 233 once, when all of the input data has been processed.
 234 .It Cm \&_c
 235 Output characters in the default character set.
 236 Nonprinting characters are displayed in three character, zero-padded
 237 octal, except for those representable by standard escape notation
 238 (see above),
 239 which are displayed as two character strings.
 240 .It Cm _p
 241 Output characters in the default character set.
 242 Nonprinting characters are displayed as a single
 243 .Dq Cm \&. .
 244 .It Cm _u
 245 Output US ASCII
 246 characters, with the exception that control characters are
 247 displayed using the following, lower-case, names.
 248 Characters greater than 0xff, hexadecimal, are displayed as hexadecimal
 249 strings.
 250 .Bl -column 000_nu 001_so 002_st 003_et 004_eo
 251 .It "000 NUL" Ta "001 SOH" Ta "002 STX" Ta "003 ETX" Ta "004 EOT" Ta "005 ENQ"
 252 .It "006 ACK" Ta "007 BEL" Ta "008 BS" Ta "009 HT" Ta "00A LF" Ta "00B VT"
 253 .It "00C FF" Ta "00D CR" Ta "00E\ SO" Ta "00F SI" Ta "010 DLE" Ta "011 DC1"
 254 .It "012 DC2" Ta "013 DC3" Ta "014 DC4" Ta "015\ NAK" Ta "016 SYN" Ta "017 ETB"
 255 .It "018 CAN" Ta "019 EM" Ta "01A SUB" Ta "01B ESC" Ta "01C FS" Ta "01D GS"
 256 .It "01E RS" Ta "01F US" Ta "07F DEL" Ta \& Ta \& Ta \&
 257 .El
 258 .El
 259 .Pp
 260 The default and supported byte counts for the conversion characters
 261 are as follows:
 262 .Bl -tag -width  "Xc,_Xc,_Xc,_Xc,_Xc,_Xc" -offset indent
 263 .It Li \&%_c , \&%_p , \&%_u , \&%c
 264 One byte counts only.
 265 .It Xo
 266 .Li \&%d , \&%i , \&%o ,
 267 .Li \&%u , \&%X , \&%x
 268 .Xc
 269 Four byte default, one, two and four byte counts supported.
 270 .It Xo
 271 .Li \&%E , \&%e , \&%f ,
 272 .Li \&%G , \&%g
 273 .Xc
 274 Eight byte default, four and twelve byte counts supported.
 275 .El
 276 .Pp
 277 The amount of data interpreted by each format string is the sum of the
 278 data required by each format unit, which is the iteration count times the
 279 byte count, or the iteration count times the number of bytes required by
 280 the format if the byte count is not specified.
 281 .Pp
 282 The input is manipulated in ``blocks'', where a block is defined as the
 283 largest amount of data specified by any format string.
 284 Format strings interpreting less than an input block's worth of data,
 285 whose last format unit both interprets some number of bytes and does
 286 not have a specified iteration count, have the iteration count
 287 incremented until the entire input block has been processed or there
 288 is not enough data remaining in the block to satisfy the format string.
 289 .Pp
 290 If, either as a result of user specification or
 291 .Nm
 292 modifying
 293 the iteration count as described above, an iteration count is
 294 greater than one, no trailing whitespace characters are output
 295 during the last iteration.
 296 .Pp
 297 It is an error to specify a byte count as well as multiple conversion
 298 characters or strings unless all but one of the conversion characters
 299 or strings is
 300 .Cm \&_a
 301 or
 302 .Cm \&_A .
 303 .Pp
 304 If, as a result of the specification of the
 305 .Fl n
 306 option or end-of-file being reached, input data only partially
 307 satisfies a format string, the input block is zero-padded sufficiently
 308 to display all available data (i.e., any format units overlapping the
 309 end of data will display some number of the zero bytes).
 310 .Pp
 311 Further output by such format strings is replaced by an equivalent
 312 number of spaces.
 313 An equivalent number of spaces is defined as the number of spaces
 314 output by an
 315 .Cm s
 316 conversion character with the same field width
 317 and precision as the original conversion character or conversion
 318 string but with any
 319 .Dq Li \&+ ,
 320 .Dq \&\ \& ,
 321 .Dq Li \&#
 322 conversion flag characters
 323 removed, and referencing a NULL string.
 324 .Pp
 325 If no format strings are specified, the default display is equivalent
 326 to specifying the
 327 .Fl x
 328 option.
 329 .Sh EXIT STATUS
 330 .Ex -std hexdump hd
 331 .Sh EXAMPLES
 332 Dump input in canonical (hex+ASCII) form:
 333 .Bd -literal -offset indent
 334 $ echo "FreeBSD: The power to serve" | hexdump -C
 335 00000000  46 72 65 65 42 53 44 3a  20 54 68 65 20 70 6f 77  |FreeBSD: The pow|
 336 00000010  65 72 20 74 6f 20 73 65  72 76 65 0a              |er to serve.|
 337 0000001c
 338 .Ed
 339 .Pp
 340 Same as above but skipping the first 4 bytes of stdin and interpreting only 3
 341 bytes of input:
 342 .Bd -literal -offset indent
 343 $ echo "FreeBSD: The power to serve" | hexdump -C -s 4 -n 3
 344 00000004  42 53 44                                          |BSD|
 345 00000007
 346 .Ed
 347 .Pp
 348 Assuming a format file named
 349 .Pa format.txt
 350 with the following contents that specify a perusal format:
 351 .Bd -literal -offset indent
 352 "%06.6_ao "  12/1 "%3_u "
 353 "\et\et" "%_p "
 354 "\en"
 355 .Ed
 356 .Pp
 357 Dump input in canonical form using the format in
 358 .Pa format.txt :
 359 .Bd -literal -offset indent
 360 $ echo "FreeBSD" | hexdump -f format.txt -C
 361 000000   F   r   e   e   B   S   D  lf                          F r e e B S D .
 362 00000000  46 72 65 65 42 53 44 0a                           |FreeBSD.|
 363 00000008
 364 .Ed
 365 .Pp
 366 Assuming a format file named
 367 .Pa format.txt
 368 with the following contents that simulate the
 369 .Fl x
 370 option:
 371 .Bd -literal -offset indent
 372 "%07.7_Ax\en"
 373 "%07.7_ax  " 8/2 "%04x " "\en"
 374 .Ed
 375 .Pp
 376 Dump input in canonical form using the format in
 377 .Pa format.txt :
 378 .Bd -literal -offset indent
 379 $ echo "FreeBSD: The power to serve" | hexdump -f format.txt -C
 380 0000000  7246 6565 5342 3a44 5420 6568 7020 776f
 381 00000000  46 72 65 65 42 53 44 3a  20 54 68 65 20 70 6f 77  |FreeBSD: The pow|
 382 0000010  7265 7420 206f 6573 7672 0a65
 383 00000010  65 72 20 74 6f 20 73 65  72 76 65 0a              |er to serve.|
 384 0000001c
 385 .Ed
 386 .Sh SEE ALSO
 387 .Xr od 1