commands/hexdump/od.1

   1 .\"  $NetBSD: od.1,v 1.25 2010/02/09 14:25:39 wiz 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 February 9, 2010
  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 The options are as follows:
  60 .Bl -tag -width Fl
  61 .It Fl A Ar base
  62 Specify the input address base.
  63 .Ar base
  64 may be one of
  65 .Ql d ,
  66 .Ql o ,
  67 .Ql x
  68 or
  69 .Ql n ,
  70 which specify decimal, octal, hexadecimal
  71 addresses or no address, respectively.
  72 .It Fl a
  73 .Em One-byte character display .
  74 Display the input offset in octal, followed by sixteen
  75 space-separated, three column, space-filled, characters of input data
  76 per line.
  77 Control characters are printed as their names instead of as
  78 C-style escapes.
  79 .It Fl B
  80 Same as
  81 .Fl o .
  82 .It Fl b
  83 .Em One-byte octal display .
  84 Display the input offset in octal, followed by sixteen
  85 space-separated, three column, zero-filled, bytes of input data, in
  86 octal, per line.
  87 This is the default output style if no other is
  88 selected.
  89 .It Fl c
  90 .Em One-byte character display .
  91 Display the input offset in octal, followed by sixteen
  92 space-separated, three column, space-filled, characters of input data
  93 per line.
  94 Control characters are printed at C-style escapes, or as
  95 three octal digits, if no C escape exists for the character.
  96 .It Fl d
  97 .Em Two-byte decimal display .
  98 Display the input offset in octal, followed by eight
  99 space-separated, five column, zero-filled, two-byte units
 100 of input data, in unsigned decimal, per line.
 101 .It Fl e
 102 .Em Eight-byte floating point display .
 103 Display the input offset in octal, followed by two space-separated,
 104 twenty-one column, space filled, eight byte units of input data, in
 105 floating point, per line.
 106 .It Fl F
 107 Same as
 108 .Fl e .
 109 .It Fl f
 110 .Em Four-byte floating point display .
 111 Display the input offset in octal, followed by four space-separated,
 112 14 column, space filled, four byte units of input data, in floating
 113 point, per line.
 114 .It Fl H
 115 .Em Four-byte hex display .
 116 Display the input offset in octal, followed by four space-separated,
 117 eight column, zero filled, four byte units of input data, in hex,
 118 per line.
 119 .It Fl h
 120 .Em Two-byte hex display .
 121 Display the input offset in octal, followed by eight space-separated,
 122 four column, zero filled, two byte units of input data, in hex,
 123 per line.
 124 .It Fl I
 125 .Em Four-byte decimal display .
 126 Display the input offset in octal, followed by four space-separated,
 127 eleven column, space filled, four byte units of input data, in
 128 decimal, per line.
 129 .It Fl i
 130 .Em Two-byte decimal display .
 131 Display the input offset in octal, followed by eight space-separated,
 132 six column, space filled, two-byte units of input data, in decimal,
 133 per line.
 134 .It Fl j Ar offset
 135 Skip
 136 .Ar offset
 137 bytes from the beginning of the input.
 138 By default,
 139 .Ar offset
 140 is interpreted as a decimal number.
 141 With a leading
 142 .Cm 0x
 143 or
 144 .Cm 0X ,
 145 .Ar offset
 146 is interpreted as a hexadecimal number,
 147 otherwise, with a leading
 148 .Cm 0 ,
 149 .Ar offset
 150 is interpreted as an octal number.
 151 Appending the character
 152 .Cm b ,
 153 .Cm k ,
 154 or
 155 .Cm m
 156 to
 157 .Ar offset
 158 causes it to be interpreted as a multiple of
 159 .Li 512 ,
 160 .Li 1024 ,
 161 or
 162 .Li 1048576 ,
 163 respectively.
 164 .It Fl L
 165 Same as
 166 .Fl I .
 167 .It Fl l
 168 Same as
 169 .Fl I .
 170 .It Fl N Ar length
 171 Interpret only
 172 .Ar length
 173 bytes of input.
 174 .It Fl O
 175 .Em Four-byte octal display .
 176 Display the input offset in octal, followed by four
 177 space-separated, eleven column, zero-filled, four-byte units
 178 of input data, in octal, per line.
 179 .It Fl o
 180 .Em Two-byte octal display .
 181 Display the input offset in octal, followed by eight
 182 space-separated, six column, zero-filled, two-byte units
 183 of input data, in octal, per line.
 184 .It Fl t Ar type_string
 185 Specify one or more output types.
 186 The
 187 .Em type_string
 188 option-argument must be a string specifying the types to be used when
 189 writing the input data.
 190 The string must consist of the type specification characters:
 191 .Pp
 192 .Cm a
 193 selects US-ASCII output, with control characters replaced with their
 194 names instead of as C escape sequences.
 195 See also the
 196 .Cm _u
 197 conversion provided by hexdump(1).
 198 .Pp
 199 .Cm c
 200 selects a standard character based conversion.
 201 See also the
 202 .Cm _c
 203 conversion provided by hexdump(1).
 204 .Pp
 205 .Cm f
 206 selects the floating point output format.
 207 This type character can be optionally followed by the characters
 208 .Cm 4
 209 or
 210 .Cm F
 211 to specify four byte floating point output, or
 212 .Cm 8
 213 or
 214 .Cm L
 215 to specify eight byte floating point output.
 216 The default output format is eight byte floats.
 217 See also the
 218 .Cm e
 219 conversion provided by hexdump(1).
 220 .Pp
 221 .Cm d ,
 222 .Cm o ,
 223 .Cm u ,
 224 or
 225 .Cm x
 226 select decimal, octal, unsigned decimal, or hex output respectively.
 227 These types can optionally be followed by
 228 .Cm C
 229 to specify
 230 .Em char Ns -sized
 231 output,
 232 .Cm S
 233 to specify
 234 .Em short Ns -sized
 235 output,
 236 .Cm I
 237 to specify
 238 .Em int Ns -sized
 239 output,
 240 .Cm L
 241 to specify
 242 .Em long Ns -sized
 243 output,
 244 .Cm 1
 245 to specify one-byte output,
 246 .Cm 2
 247 to specify two-byte output,
 248 .Cm 4
 249 to specify four-byte output, or
 250 .Cm 8
 251 to specify eight-byte output.
 252 The default output format is in four-byte quantities.
 253 See also the
 254 .Cm d ,
 255 .Cm o ,
 256 .Cm u ,
 257 and
 258 .Cm x
 259 conversions provided by hexdump(1).
 260 .\"(a|c|f[FLD]?|[doux][C1S2I4L8]?)*
 261 .It Fl v
 262 The
 263 .Fl v
 264 option causes
 265 .Nm
 266 to display all input data.
 267 Without the
 268 .Fl v
 269 option, any number of groups of output lines, which would be
 270 identical to the immediately preceding group of output lines (except
 271 for the input offsets), are replaced with a line comprised of a
 272 single asterisk.
 273 .It Fl X
 274 Same as
 275 .Fl H .
 276 .It Fl x
 277 Same as
 278 .Fl h .
 279 .El
 280 .Pp
 281 For each input file,
 282 .Nm
 283 sequentially copies the input to standard output, transforming the
 284 data according to the options given.
 285 If no options are specified, the
 286 default display is equivalent to specifying the
 287 .Fl o
 288 option.
 289 .Pp
 290 .Nm
 291 exits 0 on success and \*[Gt]0 if an error occurred.
 292 .Sh SEE ALSO
 293 .Xr hexdump 1 ,
 294 .Xr strings 1
 295 .Sh HISTORY
 296 A
 297 .Nm
 298 command appears in
 299 .At v1 .
 300 .Pp
 301 This man page was written in February 2001 by Andrew Brown, shortly
 302 after he augmented the deprecated od syntax to include things he felt
 303 had been missing for a long time.