usr.bin/hexdump/od.1

   1 .\"  $NetBSD: od.1,v 1.22 2008/04/30 13:11:01 martin Exp $
   2 .\"
   3 .\" Copyright (c) 2001 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Andrew Brown.
   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 NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"/
  30 .Dd September 3, 2008
  31 .Dt OD 1
  32 .Os
  33 .Sh NAME
  34 .Nm od
  35 .Nd octal, decimal, hex, ascii dump
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl aBbcDdeFfHhIiLlOovXx
  39 .Bk -words
  40 .Op Fl A Ar base
  41 .Op Fl j Ar skip
  42 .Ek
  43 .Bk -words
  44 .Op Fl N Ar length
  45 .Ek
  46 .Bk -words
  47 .Op Fl t Ar type_string
  48 .Ek
  49 .Sm off
  50 .Oo
  51 .Op Cm \&+
  52 .Li offset
  53 .Op Cm \&.
  54 .Op Cm Bb
  55 .Sm on
  56 .Oc
  57 .Ar file ...
  58 .Sh DESCRIPTION
  59 .Nm
  60 has been deprecated in favor of
  61 .Xr hexdump 1 .
  62 .Pp
  63 .Xr hexdump 1 ,
  64 if called as
  65 .Nm ,
  66 provides compatibility for the options described below.
  67 It does not provide compatibility for the
  68 .Fl s
  69 option (see
  70 .Xr strings 1 )
  71 or the
  72 .Fl P ,
  73 .Fl p ,
  74 or
  75 .Fl w
  76 options, nor is compatibility provided for the ``label'' component
  77 of the offset syntax.
  78 .Pp
  79 The options are as follows:
  80 .Bl -tag -width Fl
  81 .It Fl A Ar base
  82 Specify the input address base.
  83 .Ar base
  84 may be one of
  85 .Ql d ,
  86 .Ql o ,
  87 .Ql x
  88 or
  89 .Ql n ,
  90 which specify decimal, octal, hexadecimal
  91 addresses or no address, respectively.
  92 .It Fl a
  93 .Em One-byte character display .
  94 Display the input offset in octal, followed by sixteen
  95 space-separated, three column, space-filled, characters of input data
  96 per line.
  97 Control characters are printed as their names instead of as
  98 C-style escapes.
  99 .It Fl B
 100 Same as
 101 .Fl o .
 102 .It Fl b
 103 .Em One-byte octal display .
 104 Display the input offset in octal, followed by sixteen
 105 space-separated, three column, zero-filled, bytes of input data, in
 106 octal, per line.
 107 This is the default output style if no other is
 108 selected.
 109 .It Fl c
 110 .Em One-byte character display .
 111 Display the input offset in octal, followed by sixteen
 112 space-separated, three column, space-filled, characters of input data
 113 per line.
 114 Control characters are printed at C-style escapes, or as
 115 three octal digits, if no C escape exists for the character.
 116 .It Fl d
 117 .Em Two-byte decimal display .
 118 Display the input offset in octal, followed by eight
 119 space-separated, five column, zero-filled, two-byte units
 120 of input data, in unsigned decimal, per line.
 121 .It Fl e
 122 .Em Eight-byte floating point display .
 123 Display the input offset in octal, followed by two space-separated,
 124 twenty-one column, space filled, eight byte units of input data, in
 125 floating point, per line.
 126 .It Fl F
 127 Same as
 128 .Fl e .
 129 .It Fl f
 130 .Em Four-byte floating point display .
 131 Display the input offset in octal, followed by four space-separated,
 132 14 column, space filled, four byte units of input data, in floating
 133 point, per line.
 134 .It Fl H
 135 .Em Four-byte hex display .
 136 Display the input offset in octal, followed by four space-separated,
 137 eight column, zero filled, four byte units of input data, in hex,
 138 per line.
 139 .It Fl h
 140 .Em Two-byte hex display .
 141 Display the input offset in octal, followed by eight space-separated,
 142 four column, zero filled, two byte units of input data, in hex,
 143 per line.
 144 .It Fl I
 145 .Em Four-byte decimal display .
 146 Display the input offset in octal, followed by four space-separated,
 147 eleven column, space filled, four byte units of input data, in
 148 decimal, per line.
 149 .It Fl i
 150 .Em Two-byte decimal display .
 151 Display the input offset in octal, followed by eight space-separated,
 152 six column, space filled, two-byte units of input data, in decimal,
 153 per line.
 154 .It Fl j Ar offset
 155 Skip
 156 .Ar offset
 157 bytes from the beginning of the input.
 158 By default,
 159 .Ar offset
 160 is interpreted as a decimal number.
 161 With a leading
 162 .Cm 0x
 163 or
 164 .Cm 0X ,
 165 .Ar offset
 166 is interpreted as a hexadecimal number,
 167 otherwise, with a leading
 168 .Cm 0 ,
 169 .Ar offset
 170 is interpreted as an octal number.
 171 Appending the character
 172 .Cm b ,
 173 .Cm k ,
 174 or
 175 .Cm m
 176 to
 177 .Ar offset
 178 causes it to be interpreted as a multiple of
 179 .Li 512 ,
 180 .Li 1024 ,
 181 or
 182 .Li 1048576 ,
 183 respectively.
 184 .It Fl L
 185 Same as
 186 .Fl I .
 187 .It Fl l
 188 Same as
 189 .Fl I .
 190 .It Fl N Ar length
 191 Interpret only
 192 .Ar length
 193 bytes of input.
 194 .It Fl O
 195 .Em Four-byte octal display .
 196 Display the input offset in octal, followed by four
 197 space-separated, eleven column, zero-filled, four-byte units
 198 of input data, in octal, per line.
 199 .It Fl o
 200 .Em Two-byte octal display .
 201 Display the input offset in octal, followed by eight
 202 space-separated, six column, zero-filled, two-byte units
 203 of input data, in octal, per line.
 204 .It Fl t Ar type_string
 205 Specify one or more output types.
 206 The
 207 .Em type_string
 208 option-argument must be a string specifying the types to be used when
 209 writing the input data.
 210 The string must consist of the type specification characters:
 211 .Pp
 212 .Cm a
 213 selects US-ASCII output, with control characters replaced with their
 214 names instead of as C escape sequences.
 215 See also the
 216 .Cm _u
 217 conversion provided by hexdump(1).
 218 .Pp
 219 .Cm c
 220 selects a standard character based conversion.
 221 See also the
 222 .Cm _c
 223 conversion provided by hexdump(1).
 224 .Pp
 225 .Cm f
 226 selects the floating point output format.
 227 This type character can be optionally followed by the characters
 228 .Cm 4
 229 or
 230 .Cm F
 231 to specify four byte floating point output, or
 232 .Cm 8
 233 or
 234 .Cm L
 235 to specify eight byte floating point output.
 236 The default output format is eight byte floats.
 237 See also the
 238 .Cm e
 239 conversion provided by hexdump(1).
 240 .Pp
 241 .Cm d ,
 242 .Cm o ,
 243 .Cm u ,
 244 or
 245 .Cm x
 246 select decimal, octal, unsigned decimal, or hex output respectively.
 247 These types can optionally be followed by
 248 .Cm C
 249 to specify
 250 .Em char Ns -sized
 251 output,
 252 .Cm S
 253 to specify
 254 .Em short Ns -sized
 255 output,
 256 .Cm I
 257 to specify
 258 .Em int Ns -sized
 259 output,
 260 .Cm L
 261 to specify
 262 .Em long Ns -sized
 263 output,
 264 .Cm 1
 265 to specify one-byte output,
 266 .Cm 2
 267 to specify two-byte output,
 268 .Cm 4
 269 to specify four-byte output, or
 270 .Cm 8
 271 to specify eight-byte output.
 272 The default output format is in four-byte quantities.
 273 See also the
 274 .Cm d ,
 275 .Cm o ,
 276 .Cm u ,
 277 and
 278 .Cm x
 279 conversions provided by hexdump(1).
 280 .\"(a|c|f[FLD]?|[doux][C1S2I4L8]?)*
 281 .It Fl v
 282 The
 283 .Fl v
 284 option causes
 285 .Nm
 286 to display all input data.
 287 Without the
 288 .Fl v
 289 option, any number of groups of output lines, which would be
 290 identical to the immediately preceding group of output lines (except
 291 for the input offsets), are replaced with a line comprised of a
 292 single asterisk.
 293 .It Fl X
 294 Same as
 295 .Fl H .
 296 .It Fl x
 297 Same as
 298 .Fl h .
 299 .El
 300 .Pp
 301 For each input file,
 302 .Nm
 303 sequentially copies the input to standard output, transforming the
 304 data according to the options given.
 305 If no options are specified, the
 306 default display is equivalent to specifying the
 307 .Fl o
 308 option.
 309 .Pp
 310 .Nm
 311 exits 0 on success and \*[Gt]0 if an error occurred.
 312 .Sh SEE ALSO
 313 .Xr hexdump 1 ,
 314 .Xr strings 1
 315 .Sh HISTORY
 316 A
 317 .Nm
 318 command appears in
 319 .At v1 .
 320 .Pp
 321 This man page was written in February 2001 by Andrew Brown, shortly
 322 after he augmented the deprecated od syntax to include things he felt
 323 had been missing for a long time.