source: doc/reglookup.txt @ 9

Last change on this file since 9 was 9, checked in by tim, 19 years ago

Added documentation. Using txt2tags right now to generate man pages,
but output is included in repository. A simple Makefile was added as
well for doc. Main Makefile updated.

File size: 2.2 KB
Line 
1reglookup
2
3
4=NAME=
5        reglookup - Windoze NT/2K/XP registry reader/lookup tool
6
7
8=SYNOPSIS=
9        reglookup [options] <REGISTRY_FILE>
10
11
12=DESCRIPTION=
13        reglookup is designed to read Windoze registry elements and
14        print them out to stdout.  It has several filtering options to
15        narrow the focus of the output.
16
17
18=OPTIONS=
19        -f<PREFIX_FILTER>       
20                Specify a path filter.  Only keys/values under this
21                registry path will be output.
22
23        -k      TODO
24
25        -p      TODO
26
27        -s      TODO
28       
29        -t<TYPE_FILTER>
30                Specify a type filter.  Only elements which match this
31                registry data type will be printed.  Acceptable values
32                are: SZ,EXPAND_SZ,BIN,DWORD,MULTI_SZ,KEY
33
34        -v      Verbose output.
35
36
37        REGISTRY_FILE
38                Required argument.  Specifies the location of the
39                registry file to read.  Typically, these files will be
40                found on a Windoze partition under
41                %SystemRoot%/system32/config.
42
43
44=EXAMPLES=
45        To read and print an entire registry:
46
47        **reglookup /mnt/win/c/WINNT/system32/config/system**
48
49        To limit the output to just those entries under the Services
50        key:
51
52        **reglookup -f'$$$PROTO.HIV/ControlSet002/Services' /mnt/win/c/WINNT/system32/config/system**
53
54        To limit the output to all registry values of type BIN:
55
56        **reglookup -tBIN /mnt/win/c/WINNT/system32/config/system**
57       
58        And to limit the output to BIN values under the Services key:
59
60        **reglookup -tBIN -f'$$$PROTO.HIV/ControlSet002/Services' /mnt/win/c/WINNT/system32/config/system**
61
62
63=BUGS=
64        Path filtering is currently a slow hack.
65
66        The current incarnation of this program has only been tested on
67        Windoze 2000.
68
69        You'll notice that registry paths aren't all the same as the
70        ones the equivalents you see in Windoze.  Don't ask me why that
71        is.  I just work here.
72
73        This software should be considered unstable at this time.
74
75
76=CREDITS=
77        This program is based on editreg.c by Richard Sharpe.
78
79        It has since been modified by Timothy D. Morgan.
80
81        Please see source code for a full list of copyrights.
82
83
84=LICENSE=
85        Please see the file "LICENSE" included with this software
86        distribution.
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 version 2 for more details.
Note: See TracBrowser for help on using the repository browser.