Pre-build commit
[packages/dc3dd.git] / README
1 dc3dd 7.1
2 DCCI 
3 2010-10-18
4
5 Issues:
6 -------
7 When imaging to a device with verification under Mac OS X, verification
8 can fail due to automatic mounting of the target device. One solution is
9 to use Disk Arbitrator in conjunction with dc3dd on OS X.    
10
11 New Features:
12 -------------
13 Log output may be sent to multiple job logs and hash logs. Simply specify
14 log=LOG and/or hlog=LOG more than once.
15
16 Verification of an image restored to a device larger than the image is now
17 supported. Specify phod=DEVICE to hash only the bytes dc3dd writes to the
18 device. Specify fhod=DEVICE to hash both the bytes dc3dd writes to the
19 device and all the bytes that follow, up to the end of the device.   
20
21 Building dc3dd:
22 ---------------
23 dc3dd is distributed as source code and must be compiled before use.
24 The default configuration can be built and installed to /usr/local/bin
25 with the following commands:
26
27 $ tar zxvf dc3dd-7.1.tar.gz
28 $ cd dc3dd-7.1
29 $ ./configure
30 $ make
31 $ sudo make install
32
33 Note that autoconf-1.10.1 and gperf may need to be installed prior to
34 execution of the above commands.
35
36 dc3dd can be customized at compile-time with various options.
37 The available options are as follows, and can be verified after
38 compilation using the --flags command line option: 
39
40 -DDEFAULT_HASH_MD5
41 (equivalent to hash=md5 command-line option)
42
43 -DDEFAULT_HASH_SHA1
44 (equivalent to hash=sha1 command-line option)
45
46 -DDEFAULT_HASH_SHA256
47 (equivalent to hash=sha256 command-line option)
48
49 -DDEFAULT_HASH_SHA512
50 (equivalent to hash=sha512 command-line option)
51
52 -DDEFAULT_OUTPUT_FILE_SIZE=BYTES
53 (equivalent to ofsz=BYTES command-line option)
54
55 -DDEFAULT_VERBOSE_REPORTING
56 (equivalent to verb=on command-line option)
57
58 -DDEFAULT_COMPACT_REPORTING
59 (equivalent to nwspc=on command-line option)
60
61 -DDEFAULT_DECIMAL_BYTES_REPORTING
62 (equivalent to dbr=on command-line option)
63
64 --enable-hpadco
65 Enable checking ATA/SATA drives for hidden areas
66 No command-line equivalent, cannot be overridden.
67
68 These options are enabled by including them in the CFLAGS argument to
69 configure. For example, to enable MD5 hashing and default output file
70 size:
71
72 $ ./configure CFLAGS="-O2 -DDEFAULT_HASH_MD5 
73 -DDEFAULT_OUTPUT_FILE_SIZE=1900M"
74
75 The program can be statically linked by adding "-static" to the CFLAGS
76 compile options:
77
78 $ ./configure CFLAGS="-O2 -static"
79
80 Portability Notes:
81 ------------------
82 Mac OS X:
83 To enable error recovery, use /dev/rdisk* instead of /dev/disk*
84
85 Windows:
86 dc3dd can be compiled using Cygwin, but bad sectors can put the program
87 into an infinite loop due to bugs in Cygwin.
88
89 Please send all correspondence to: dc3dd@dc3.mil