bin/dd/dd.1

   1 .\"-
   2 .\" Copyright (c) 1990, 1993
   3 .\"     The Regents of the University of California.  All rights reserved.
   4 .\"
   5 .\" This code is derived from software contributed to Berkeley by
   6 .\" Keith Muller of the University of California, San Diego.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)dd.1        8.2 (Berkeley) 1/13/94
  33 .\" $FreeBSD: head/bin/dd/dd.1 337505 2018-08-08 21:37:02Z kevans $
  34 .\"
  35 .Dd February 14, 2019
  36 .Dt DD 1
  37 .Os
  38 .Sh NAME
  39 .Nm dd
  40 .Nd convert and copy a file
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Ar operands ...
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 utility copies the standard input to the standard output.
  48 Input data is read and written in 512-byte blocks.
  49 If input reads are short, input from multiple reads are aggregated
  50 to form the output block.
  51 When finished,
  52 .Nm
  53 displays the number of complete and partial input and output blocks
  54 and truncated input records to the standard error output.
  55 .Pp
  56 The following operands are available:
  57 .Bl -tag -width "of=file"
  58 .It Cm bs Ns = Ns Ar n
  59 Set both input and output block size to
  60 .Ar n
  61 bytes, superseding the
  62 .Cm ibs
  63 and
  64 .Cm obs
  65 operands.
  66 If no conversion values other than
  67 .Cm noerror ,
  68 .Cm notrunc
  69 or
  70 .Cm sync
  71 are specified, then each input block is copied to the output as a
  72 single block without any aggregation of short blocks.
  73 .It Cm cbs Ns = Ns Ar n
  74 Set the conversion record size to
  75 .Ar n
  76 bytes.
  77 The conversion record size is required by the record oriented conversion
  78 values.
  79 .It Cm count Ns = Ns Ar n
  80 Copy only
  81 .Ar n
  82 input blocks.
  83 .It Cm files Ns = Ns Ar n
  84 Copy
  85 .Ar n
  86 input files before terminating.
  87 This operand is only applicable when the input device is a tape.
  88 .It Cm fillchar Ns = Ns Ar c
  89 When padding a block in conversion mode or due to use of
  90 .Cm noerror
  91 and
  92 .Cm sync
  93 modes, fill with the specified
  94 .Tn ASCII
  95 character, rather than using a space or
  96 .Dv NUL .
  97 .It Cm ibs Ns = Ns Ar n
  98 Set the input block size to
  99 .Ar n
 100 bytes instead of the default 512.
 101 .It Cm if Ns = Ns Ar file
 102 Read input from
 103 .Ar file
 104 instead of the standard input.
 105 .It Cm iseek Ns = Ns Ar n
 106 Seek on the input file
 107 .Ar n
 108 blocks.
 109 This is synonymous with
 110 .Cm skip Ns = Ns Ar n .
 111 .It Cm obs Ns = Ns Ar n
 112 Set the output block size to
 113 .Ar n
 114 bytes instead of the default 512.
 115 .It Cm of Ns = Ns Ar file
 116 Write output to
 117 .Ar file
 118 instead of the standard output.
 119 Any regular output file is truncated unless the
 120 .Cm notrunc
 121 conversion value is specified.
 122 If an initial portion of the output file is seeked past (see the
 123 .Cm oseek
 124 operand),
 125 the output file is truncated at that point.
 126 .It Cm oseek Ns = Ns Ar n
 127 Seek on the output file
 128 .Ar n
 129 blocks.
 130 This is synonymous with
 131 .Cm seek Ns = Ns Ar n .
 132 .It Cm seek Ns = Ns Ar n
 133 Seek
 134 .Ar n
 135 blocks from the beginning of the output before copying.
 136 On non-tape devices, an
 137 .Xr lseek 2
 138 operation is used.
 139 Otherwise, existing blocks are read and the data discarded.
 140 If the user does not have read permission for the tape, it is positioned
 141 using the tape
 142 .Xr ioctl 2
 143 function calls.
 144 If the seek operation is past the end of file, space from the current
 145 end of file to the specified offset is filled with blocks of
 146 .Dv NUL
 147 bytes.
 148 .It Cm skip Ns = Ns Ar n
 149 Skip
 150 .Ar n
 151 blocks from the beginning of the input before copying.
 152 On input which supports seeks, an
 153 .Xr lseek 2
 154 operation is used.
 155 Otherwise, input data is read and discarded.
 156 For pipes, the correct number of bytes is read.
 157 For all other devices, the correct number of blocks is read without
 158 distinguishing between a partial or complete block being read.
 159 .It Cm speed Ns = Ns Ar n
 160 Limit the copying speed to
 161 .Ar n
 162 bytes per second.
 163 .It Cm status Ns = Ns Ar value
 164 Where
 165 .Cm value
 166 is one of the symbols from the following list.
 167 .Bl -tag -width ".Cm progress"
 168 .It Cm none
 169 Do not print the status output.
 170 Error messages are shown; informational messages are not.
 171 .It Cm noxfer
 172 Do not print the transfer statistics as the last line of status output.
 173 .It Cm progress
 174 Print basic transfer statistics once per second.
 175 .El
 176 .It Cm conv Ns = Ns Ar value Ns Op , Ns Ar value ...
 177 Where
 178 .Cm value
 179 is one of the symbols from the following list.
 180 .Bl -tag -width "unblock"
 181 .It Cm ascii , oldascii
 182 The same as the
 183 .Cm unblock
 184 value except that characters are translated from
 185 .Tn EBCDIC
 186 to
 187 .Tn ASCII
 188 before the
 189 records are converted.
 190 (These values imply
 191 .Cm unblock
 192 if the operand
 193 .Cm cbs
 194 is also specified.)
 195 There are two conversion maps for
 196 .Tn ASCII .
 197 The value
 198 .Cm ascii
 199 specifies the recommended one which is compatible with
 200 .At V .
 201 The value
 202 .Cm oldascii
 203 specifies the one used in historic
 204 .At
 205 and
 206 .No pre- Ns Bx 4.3 reno
 207 systems.
 208 .It Cm block
 209 Treats the input as a sequence of newline or end-of-file terminated variable
 210 length records independent of input and output block boundaries.
 211 Any trailing newline character is discarded.
 212 Each input record is converted to a fixed length output record where the
 213 length is specified by the
 214 .Cm cbs
 215 operand.
 216 Input records shorter than the conversion record size are padded with spaces.
 217 Input records longer than the conversion record size are truncated.
 218 The number of truncated input records, if any, are reported to the standard
 219 error output at the completion of the copy.
 220 .It Cm ebcdic , ibm , oldebcdic , oldibm
 221 The same as the
 222 .Cm block
 223 value except that characters are translated from
 224 .Tn ASCII
 225 to
 226 .Tn EBCDIC
 227 after the
 228 records are converted.
 229 (These values imply
 230 .Cm block
 231 if the operand
 232 .Cm cbs
 233 is also specified.)
 234 There are four conversion maps for
 235 .Tn EBCDIC .
 236 The value
 237 .Cm ebcdic
 238 specifies the recommended one which is compatible with
 239 .At V .
 240 The value
 241 .Cm ibm
 242 is a slightly different mapping, which is compatible with the
 243 .At V
 244 .Cm ibm
 245 value.
 246 The values
 247 .Cm oldebcdic
 248 and
 249 .Cm oldibm
 250 are maps used in historic
 251 .At
 252 and
 253 .No pre- Ns Bx 4.3 reno
 254 systems.
 255 .It Cm lcase
 256 Transform uppercase characters into lowercase characters.
 257 .It Cm pareven , parnone , parodd , parset
 258 Output data with the specified parity.
 259 The parity bit on input is stripped unless
 260 .Tn EBCDIC
 261 to
 262 .Tn ASCII
 263 conversions is also specified.
 264 .It Cm noerror
 265 Do not stop processing on an input error.
 266 When an input error occurs, a diagnostic message followed by the current
 267 input and output block counts will be written to the standard error output
 268 in the same format as the standard completion message.
 269 If the
 270 .Cm sync
 271 conversion is also specified, any missing input data will be replaced
 272 with
 273 .Dv NUL
 274 bytes (or with spaces if a block oriented conversion value was
 275 specified) and processed as a normal input buffer.
 276 If the
 277 .Cm fillchar
 278 option is specified, the fill character provided on the command line
 279 will override
 280 the automatic selection of the fill character.
 281 If the
 282 .Cm sync
 283 conversion is not specified, the input block is omitted from the output.
 284 On input files which are not tapes or pipes, the file offset
 285 will be positioned past the block in which the error occurred using
 286 .Xr lseek 2 .
 287 .It Cm notrunc
 288 Do not truncate the output file.
 289 This will preserve any blocks in the output file not explicitly written
 290 by
 291 .Nm .
 292 The
 293 .Cm notrunc
 294 value is not supported for tapes.
 295 .It Cm osync
 296 Pad the final output block to the full output block size.
 297 If the input file is not a multiple of the output block size
 298 after conversion, this conversion forces the final output block
 299 to be the same size as preceding blocks for use on devices that require
 300 regularly sized blocks to be written.
 301 This option is incompatible with use of the
 302 .Cm bs Ns = Ns Ar n
 303 block size specification.
 304 .It Cm sparse
 305 If one or more output blocks would consist solely of
 306 .Dv NUL
 307 bytes, try to seek the output file by the required space instead of
 308 filling them with
 309 .Dv NUL Ns s ,
 310 resulting in a sparse file.
 311 .It Cm swab
 312 Swap every pair of input bytes.
 313 If an input buffer has an odd number of bytes, the last byte will be
 314 ignored during swapping.
 315 .It Cm sync
 316 Pad every input block to the input buffer size.
 317 Spaces are used for pad bytes if a block oriented conversion value is
 318 specified, otherwise
 319 .Dv NUL
 320 bytes are used.
 321 .It Cm ucase
 322 Transform lowercase characters into uppercase characters.
 323 .It Cm unblock
 324 Treats the input as a sequence of fixed length records independent of input
 325 and output block boundaries.
 326 The length of the input records is specified by the
 327 .Cm cbs
 328 operand.
 329 Any trailing space characters are discarded and a newline character is
 330 appended.
 331 .El
 332 .El
 333 .Pp
 334 Where sizes or speed are specified, a decimal, octal, or hexadecimal number of
 335 bytes is expected.
 336 If the number ends with a
 337 .Dq Li b ,
 338 .Dq Li k ,
 339 .Dq Li m ,
 340 .Dq Li g ,
 341 .Dq Li t ,
 342 .Dq Li p ,
 343 or
 344 .Dq Li w ,
 345 the
 346 number is multiplied by 512, 1024 (1K), 1048576 (1M), 1073741824 (1G),
 347 1099511627776 (1T), 1125899906842624 (1P)
 348 or the number of bytes in an integer, respectively.
 349 Two or more numbers may be separated by an
 350 .Dq Li x
 351 to indicate a product.
 352 .Pp
 353 When finished,
 354 .Nm
 355 displays the number of complete and partial input and output blocks,
 356 truncated input records and odd-length byte-swapping blocks to the
 357 standard error output.
 358 A partial input block is one where less than the input block size
 359 was read.
 360 A partial output block is one where less than the output block size
 361 was written.
 362 Partial output blocks to tape devices are considered fatal errors.
 363 Otherwise, the rest of the block will be written.
 364 Partial output blocks to character devices will produce a warning message.
 365 A truncated input block is one where a variable length record oriented
 366 conversion value was specified and the input line was too long to
 367 fit in the conversion record or was not newline terminated.
 368 .Pp
 369 Normally, data resulting from input or conversion or both are aggregated
 370 into output blocks of the specified size.
 371 After the end of input is reached, any remaining output is written as
 372 a block.
 373 This means that the final output block may be shorter than the output
 374 block size.
 375 .Pp
 376 If
 377 .Nm
 378 receives a
 379 .Dv SIGINFO
 380 (see the
 381 .Cm status
 382 argument for
 383 .Xr stty 1 )
 384 signal, the current input and output block counts will
 385 be written to the standard error output
 386 in the same format as the standard completion message.
 387 If
 388 .Nm
 389 receives a
 390 .Dv SIGINT
 391 signal, the current input and output block counts will
 392 be written to the standard error output
 393 in the same format as the standard completion message and
 394 .Nm
 395 will exit.
 396 .Sh EXIT STATUS
 397 .Ex -std
 398 .Sh EXAMPLES
 399 Check that a disk drive contains no bad blocks:
 400 .Pp
 401 .Dl "dd if=/dev/da0 of=/dev/null bs=1m"
 402 .Pp
 403 Do a refresh of a disk drive, in order to prevent presently
 404 recoverable read errors from progressing into unrecoverable read errors:
 405 .Pp
 406 .Dl "dd if=/dev/da0 of=/dev/da0 bs=1m"
 407 .Pp
 408 Remove parity bit from a file:
 409 .Pp
 410 .Dl "dd if=file conv=parnone of=file.txt"
 411 .Pp
 412 Check for (even) parity errors on a file:
 413 .Pp
 414 .Dl "dd if=file conv=pareven | cmp -x - file"
 415 .Pp
 416 To create an image of a Mode-1 CD-ROM, which is a commonly used format
 417 for data CD-ROM disks, use a block size of 2048 bytes:
 418 .Pp
 419 .Dl "dd if=/dev/cd0 of=filename.iso bs=2048"
 420 .Pp
 421 Write a filesystem image to a memory stick, padding the end with zeros,
 422 if necessary, to a 1MiB boundary:
 423 .Pp
 424 .Dl "dd if=memstick.img of=/dev/da8 bs=1m conv=noerror,sync"
 425 .Sh SEE ALSO
 426 .Xr cp 1 ,
 427 .Xr mt 1 ,
 428 .Xr tr 1
 429 .Sh STANDARDS
 430 The
 431 .Nm
 432 utility is expected to be a superset of the
 433 .St -p1003.2
 434 standard.
 435 The
 436 .Cm files
 437 and
 438 .Cm status
 439 operands and the
 440 .Cm ascii ,
 441 .Cm ebcdic ,
 442 .Cm ibm ,
 443 .Cm oldascii ,
 444 .Cm oldebcdic
 445 and
 446 .Cm oldibm
 447 values are extensions to the
 448 .Tn POSIX
 449 standard.
 450 .Sh HISTORY
 451 A
 452 .Nm
 453 command appeared in
 454 .At v5 .