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