Fix encoding of Windows XP #2 SOFTWARE hive.
[hivex-test-data.git] / README
1 hivex-test-data contains data for extra tests of the hivex Windows
2 Registry project (http://libguestfs.org/hivex.3.html)
3
4 Since the data mainly consists of the registry hives from actual
5 Windows machines, it is not freely redistributable and so it cannot be
6 included in the main hivex source package.  Another reason is these
7 files are pretty big.
8
9 Running the tests
10 -----------------
11
12 You will need the main hivex source package.  Build hivex as normal
13 (eg. './configure && make && make check').  Then run the extra tests:
14
15   make -C extra-tests check HIVEX_TEST_DATA=/path/to/hivex-test-data
16
17 where obviously you need to set HIVEX_TEST_DATA to point to these
18 files.  HIVEX_TEST_DATA defaults to ../hivex-test-data so if you have
19 hivex & hivex-test-data checked out under the same directory it should
20 just work.
21
22 Format of the data
23 ------------------
24
25 Each *.xz file in this directory is an xz-compressed Windows registry
26 file.
27
28 The corresponding *.reg file is the expected 'hivexregedit --export'
29 output for this registry.
30
31 Developer information
32 ---------------------
33
34 You can contribute hives (especially ones which hivex has trouble
35 with) by sending them to 'rjones@redhat.com'.
36
37 Note that hives may contain private information such as applications
38 installed, web pages visited, and passwords.  In particular, the 'SAM'
39 hive contains Windows usernames and hashed passwords.  So don't
40 contribute stuff unless you're happy to see this information publicly
41 available.