BSD 4_3_Reno development

[unix-history] / usr / share / man / cat1 / hexdump.0

HEXDUMP(1)		    UNIX Reference Manual		    HEXDUMP(1)

N\bNA\bAM\bME\bE
     h\bhe\bex\bxd\bdu\bum\bmp\bp - ascii, decimal, hexadecimal, octal dump

S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
     h\bhe\bex\bxd\bdu\bum\bmp\bp [-\b-b\bbc\bcd\bdo\bov\bvx\bx] [-\b-e\be _\bf_\bo_\br_\bm_\ba_\bt__\bs_\bt_\br_\bi_\bn_\bg] [-\b-f\bf _\bf_\bo_\br_\bm_\ba_\bt__\bf_\bi_\bl_\be] [-\b-n\bn _\bl_\be_\bn_\bg_\bt_\bh]
	     [-\b-s\bs _\bs_\bk_\bi_\bp] _\bf_\bi_\bl_\be ...

D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
     The hexdump utility is a filter which displays the specified files, or
     the standard input, if no files are specified, in a user specified for-
     mat.

     The options are as follows:

     -\b-b\bb        _\bO_\bn_\be-_\bb_\by_\bt_\be _\bo_\bc_\bt_\ba_\bl _\bd_\bi_\bs_\bp_\bl_\ba_\by.	Display the input offset in hexade-
	       cimal, followed by sixteen space-separated, three column,
	       zero-filled, bytes of input data, in octal, per line.

     -\b-c\bc        _\bO_\bn_\be-_\bb_\by_\bt_\be _\bc_\bh_\ba_\br_\ba_\bc_\bt_\be_\br _\bd_\bi_\bs_\bp_\bl_\ba_\by.  Display the input offset in hexa-
	       decimal, followed by sixteen space-separated, three column,
	       space-filled, characters of input data per line.

     -\b-d\bd        _\bT_\bw_\bo-_\bb_\by_\bt_\be _\bd_\be_\bc_\bi_\bm_\ba_\bl _\bd_\bi_\bs_\bp_\bl_\ba_\by.  Display the input offset in hexade-
	       cimal, followed by eight space-separated, five column, zero-
	       filled, two-byte units of input data, in unsigned decimal, per
	       line.

     -\b-e\be _\bf_\bo_\br_\bm_\ba_\bt__\bs_\bt_\br_\bi_\bn_\bg
	       Specify a format string to be used for displaying data.

     -\b-f\bf _\bf_\bo_\br_\bm_\ba_\bt__\bf_\bi_\bl_\be
	       Specify a file that contains one or more newline separated
	       format strings.	Empty lines and lines whose first non-blank
	       character is a hash mark (#\b#) are ignored.

     -\b-n\bn _\bl_\be_\bn_\bg_\bt_\bh
	       Interpret only _\bl_\be_\bn_\bg_\bt_\bh bytes of input.

     -\b-o\bo        _\bT_\bw_\bo-_\bb_\by_\bt_\be _\bo_\bc_\bt_\ba_\bl _\bd_\bi_\bs_\bp_\bl_\ba_\by.	Display the input offset in hexade-
	       cimal, followed by eight space-separated, six column, zero-
	       filled, two byte quantities of input data, in octal, per line.

     -\b-s\bs _\bo_\bf_\bf_\bs_\be_\bt
	       Skip _\bo_\bf_\bf_\bs_\be_\bt bytes from the beginning of the input.  By default,
	       _\bo_\bf_\bf_\bs_\be_\bt is interpreted as a decimal number.  With a leading 0\b0x\bx
	       or 0\b0X\bX, _\bo_\bf_\bf_\bs_\be_\bt is interpreted as a hexadecimal number, other-
	       wise, with a leading 0\b0, _\bo_\bf_\bf_\bs_\be_\bt is interpreted as an octal
	       number.	Appending the character b\bb, k\bk, or m\bm to _\bo_\bf_\bf_\bs_\be_\bt causes it
	       to be interpreted as a multiple of 512, 1024, or 1048576,
	       respectively.

     -\b-v\bv        The -\b-v\bv option causes hexdump to display all input data.
	       Without the -\b-v\bv option, any number of groups of output lines,
	       which would be identical to the immediately preceding group of
	       output lines (except for the input offsets), are replaced with
	       a line comprised of a single asterisk.

     -\b-x\bx        _\bT_\bw_\bo-_\bb_\by_\bt_\be _\bh_\be_\bx_\ba_\bd_\be_\bc_\bi_\bm_\ba_\bl _\bd_\bi_\bs_\bp_\bl_\ba_\by.  Display the input offset in hex-
	       adecimal, followed by eight, space separated, four column,
	       zero-filled, two-byte quantities of input data, in hexadecimal,
	       per line.

     For each input file, h\bhe\bex\bxd\bdu\bum\bmp\bp sequentially copies the input to standard
     output, transforming the data according to the format strings specified
     by the -\b-e\be and -\b-f\bf options, in the order that they were specified.
  F\bFo\bor\brm\bma\bat\bts\bs
     A format string contains any number of format units, separated by whi-
     tespace.  A format unit contains up to three items: an iteration count, a
     byte count, and a format.

     The iteration count is an optional positive integer, which defaults to
     one.  Each format is applied iteration count times.

     The byte count is an optional positive integer.  If specified it defines
     the number of bytes to be interpreted by each iteration of the format.

     If an iteration count and/or a byte count is specified, a single slash
     must be placed after the iteration count and/or before the byte count to
     disambiguate them.  Any whitespace before or after the slash is ignored.

     The format is required and must be surrounded by double quote (" ")
     marks.  It is interpreted as a fprintf-style format string (see
     fprintf(3)), with the following exceptions:

	   o\bo\b\b\b+\b+	 An asterisk (*) may not be used as a field width or preci-
		 sion.

	   o\bo\b\b\b+\b+	 A byte count or field precision _\bi_\bs required for each ``s''
		 conversion character (unlike the fprintf(3) default which
		 prints the entire string if the precision is unspecified).

	   o\bo\b\b\b+\b+	 The conversion characters ``h'', ``n'', and ``p'' are not
		 supported.

	   o\bo\b\b\b+\b+	 The single character escape sequences described in the C
		 standard are supported:

		       NUL		    \0
		       <alert character>    \a
		       <backspace>	    \b
		       <form-feed>	    \f
		       <newline>	    \n
		       <carriage return>    \r
		       <tab>		    \t
		       <vertical tab>	    \v

     Hexdump also supports the the following additional conversion strings:

     _\b_a\ba[d\bdo\box\bx]   Display the input offset, cumulative across input files, of the
	       next byte to be displayed.  The appended characters d\bd, o\bo, and x\bx
	       specify the display base as decimal, octal or hexadecimal
	       respectively.

     _\b_A\bA[d\bdo\box\bx]   Identical to the _\b_a\ba conversion string except that it is only
	       performed once, when all of the input data has been processed.

     _\b_c\bc        Output characters in the default character set.	Nonprinting
	       characters are displayed in three character, zero-padded octal,
	       except for those representable by standard escape notation (see
	       above), which are displayed as two character strings.

     _\b_p\bp        Output characters in the default character set.	Nonprinting
	       characters are displayed as a single ``.\b.''.

     _\b_u\bu        Output US ASCII characters, with the exception that control
	       characters are displayed using the following, lower-case,
	       names.  Characters greater than 0xff, hexadecimal, are
	       displayed as hexadecimal strings.

	       000 nul	  001 soh    002 stx	003 etx    004 eot    005 enq
	       006 ack	  007 bel    008 bs	009 ht	   00A lf     00B vt
	       00C ff	  00D cr     00E so	00F si	   010 dle    011 dc1
	       012 dc2	  013 dc3    014 dc4	015 nak    016 syn    017 etb
	       018 can	  019 em     01A sub	01B esc    01C fs     01D gs
	       01E rs	  01F us     0FF del

     The default and supported byte counts for the conversion characters are
     as follows:

	   %_c, %_p, %_u, %c	    One byte counts only.

	   %d, %i, %o, %u, %X, %x   Four byte default, one and two byte counts
				    supported.

	   %E, %e, %f, %G, %g	    Eight byte default, four byte counts
				    supported.

     The amount of data interpreted by each format string is the sum of the
     data required by each format unit, which is the iteration count times the
     byte count, or the iteration count times the number of bytes required by
     the format if the byte count is not specified.

     The input is manipulated in ``blocks'', where a block is defined as the
     largest amount of data specified by any format string.  Format strings
     interpreting less than an input block's worth of data, whose last format
     unit both interprets some number of bytes and does not have a specified
     iteration count, have the the interation count incremented until the
     entire input block has been processed or there is not enough data
     remaining in the block to satisfy the format string.

     If, either as a result of user specification or hexdump modifying the
     iteration count as described above, an iteration count is greater than
     one, no trailing whitespace characters are output during the last
     iteration.

     It is an error to specify a byte count as well as multiple conversion
     characters or strings unless all but one of the conversion characters or
     strings is _\b_a\ba or _\b_A\bA.

     If, as a result of the specification of the -\b-n\bn option or end-of-file be-
     ing reached, input data only partially satisfies a format string, the in-
     put block is zero-padded sufficiently to display all available data (i.e.
     any format units overlapping the end of data will display some number of
     the zero bytes).

     Further output by such format strings is replaced by an equivalent number
     of spaces.  An equivalent number of spaces is defined as the number of
     spaces output by an s\bs conversion character with the same field width and
     precision as the original conversion character or conversion string but
     with any ``+'', `` '', ``#'' conversion flag characters removed, and re-
     ferencing a NULL string.

     If no format strings are specified, the default display is equivalent to
     specifying the -\b-x\bx option.

     h\bhe\bex\bxd\bdu\bum\bmp\bp exits 0 on success and >0 if an error occurred.

E\bEX\bXA\bAM\bMP\bPL\bLE\bES\bS
     Display the input in perusal format:

	   "%06.6_ao "	12/1 "%3_u "
	   "\t\t" "%_p "
	   "\n"

     Implement the -x option:


	   "%07.7_Ax\n"
	   "%07.7_ax  " 8/2 "%04x " "\n"

S\bSE\bEE\bE A\bAL\bLS\bSO\bO
     adb(1)

S\bST\bTA\bAN\bND\bDA\bAR\bRD\bDS\bS
     The h\bhe\bex\bxd\bdu\bum\bmp\bp utility is expected to be POSIX 1003.2 compatible.