Fix conditional test for HAVE_HIVEXSH.
[hivex.git] / sh / hivexget.pod
1 =encoding utf8
2
3 =head1 NAME
4
5 hivexget - Get subkey from a Windows Registry binary "hive" file
6
7 =head1 SYNOPSIS
8
9  hivexget hivefile '\Path\To\SubKey'
10
11  hivexget hivefile '\Path\To\SubKey' name
12
13 =head1 NOTE
14
15 This is a low-level tool.  For a more convenient way to navigate the
16 Windows Registry in Windows virtual machines, see L<virt-win-reg(1)>.
17 For proper regedit formatting, use L<hivexregedit(1)>.
18
19 =head1 DESCRIPTION
20
21 This program navigates through a Windows Registry binary "hive"
22 file and extracts I<either> all the (key, value) data pairs
23 stored in that subkey I<or> just the single named data item.
24
25 In the first form:
26
27  hivexget hivefile '\Path\To\SubKey'
28
29 C<hivefile> is some Windows Registry binary hive, and C<\Path\To\Subkey>
30 is a path within that hive.  I<NB> the path is relative to the top
31 of this hive, and is I<not> the full path as you would use in Windows
32 (eg. C<HKEY_LOCAL_MACHINE\SYSTEM> is not a valid path).
33
34 If the subkey exists, then the output lists all data pairs under this
35 subkey, in a format similar to C<regedit> in Windows.
36
37 In the second form:
38
39  hivexget hivefile '\Path\To\SubKey' name
40
41 C<hivefile> and path are as above.  C<name> is the name of the value
42 of interest (use C<@> for the default value).
43
44 The corresponding data item is printed "raw" (ie. no processing or
45 escaping) except:
46
47 =over 4
48
49 =item 1
50
51 If it's a string we will convert it from Windows UTF-16 to UTF-8, if
52 this conversion is possible.  The string is printed with a single
53 trailing newline.
54
55 =item 2
56
57 If it's a multiple-string value, each string is printed on a separate
58 line.
59
60 =item 3
61
62 If it's a numeric value, it is printed as a decimal number.
63
64 =back
65
66 =head1 SEE ALSO
67
68 L<hivex(3)>,
69 L<hivexml(1)>,
70 L<hivexsh(1)>,
71 L<hivexregedit(1)>,
72 L<virt-win-reg(1)>,
73 L<guestfs(3)>,
74 L<http://libguestfs.org/>,
75 L<virt-cat(1)>,
76 L<virt-edit(1)>.
77
78 =head1 AUTHORS
79
80 Richard W.M. Jones (C<rjones at redhat dot com>)
81
82 =head1 COPYRIGHT
83
84 Copyright (C) 2009 Red Hat Inc.
85
86 This program is free software; you can redistribute it and/or modify
87 it under the terms of the GNU General Public License as published by
88 the Free Software Foundation; either version 2 of the License, or
89 (at your option) any later version.
90
91 This program is distributed in the hope that it will be useful,
92 but WITHOUT ANY WARRANTY; without even the implied warranty of
93 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
94 GNU General Public License for more details.
95
96 You should have received a copy of the GNU General Public License along
97 with this program; if not, write to the Free Software Foundation, Inc.,
98 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.