source: trunk/doc/reglookup-timeline.1.docbook @ 87

Last change on this file since 87 was 87, checked in by tim, 17 years ago

added minor documentation on ACE flags to regfi.c

vastly expanded output documentation in reglookup man page.

  • Property svn:keywords set to Id
File size: 3.8 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<refentry id='reglookup-timeline.1'>
3  <!--  $Id: reglookup-timeline.1.docbook 87 2007-02-04 01:55:18Z tim $ -->
4  <refmeta>
5    <refentrytitle>reglookup-timeline</refentrytitle>
6    <manvolnum>1</manvolnum>
7    <refmiscinfo class="sectdesc">File Conversion Utilities</refmiscinfo>
8  </refmeta>
9  <refnamediv id='name'>
10    <refname>reglookup-timeline</refname>
11    <refpurpose>windows NT+ registry MTIME timeline generator</refpurpose>
12  </refnamediv>
13
14  <refsect1 id='synopsis'>
15    <title>SYNOPSIS</title>
16    <para>
17      <command>
18        reglookup-timeline <replaceable>registry-file</replaceable>
19                           [<replaceable>registry-file</replaceable> ...]
20      </command>
21    </para>
22  </refsect1>
23
24  <refsect1 id='description'>
25    <title>DESCRIPTION</title>
26    <para>
27      This script is a wrapper for <command>reglookup(1)</command>, and reads
28      one or more registry
29      files to produce an MTIME sorted output.  This is helpful when building
30      timelines for forensic investigations.
31    </para>
32  </refsect1>
33
34  <refsect1 id='parameters'>
35    <title>PARAMETERS</title>
36    <para>
37      <command>reglookup-timeline</command> accepts one or more registry file
38      names.  All of the provided registries will be parsed using
39      <command>reglookup(1)</command>.
40    </para>
41  </refsect1>
42
43  <refsect1 id='output'>
44    <title>OUTPUT</title>
45    <para>
46      <command>reglookup-timeline</command> generates a comma-separated
47      values (CSV) compatible format to stdout.  While the output of
48      <command>reglookup-timeline</command> and <command>reglookup(1)</command>
49      differ in the columns returned, the base format is the same. 
50    </para>
51    <para>
52      Currently, <command>reglookup-timeline</command> returns three columns:
53      MTIME, FILE, and PATH.  Only rows representing registry keys are returned,
54      since MTIMEs are not stored for values.  The FILE column indicates which
55      registry file (provided as an argument) the key came from.  Finally, the
56      PATH field contains the full registry path to the key.  Records are
57      returned sorted in ascending order based on the MTIME column.
58    </para>
59  </refsect1>
60
61  <refsect1 id='bugs'>
62    <title>BUGS</title>
63    <para>
64      This script is new, and as such it's interface may change significantly
65      over the next few revisions.  In particular, additional command line
66      options will likely be added, and the output of the script may be altered
67      in minor ways.
68    </para>
69    <para>
70      It is very difficult to find documentation on what precise operations
71      cause the MTIMEs to be updated.  Basic experimentation indicates that
72      a key's stamp is updated anytime an immediate sub-value or sub-key is
73      created, renamed, deleted, or it's value is modified.  If this MTIME
74      data is critical to an investigation, any conclusions should be
75      validated through experimentation in a controlled lab environment.
76    </para>
77    <para>
78      This software should be considered unstable at this time.
79    </para>
80  </refsect1>
81
82  <refsect1 id='credits'>
83    <title>CREDITS</title>
84    <para>
85      This script was written by Timothy D. Morgan based on suggestions
86      from Uwe Danz.
87    </para>
88    <para>
89      Please see source code for a full list of copyrights.
90    </para>
91  </refsect1>
92
93  <refsect1 id='license'>
94    <title>LICENSE</title>
95    <para>
96      Please see the file "LICENSE" included with this software
97      distribution.
98    </para>
99    <para>     
100      This program is distributed in the hope that it will be useful,
101      but WITHOUT ANY WARRANTY; without even the implied warranty of
102      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
103      GNU General Public License version 2 for more details.
104    </para>
105  </refsect1>
106
107  <refsect1 id='seealso'>
108    <title>SEE ALSO</title>
109    <para>
110      reglookup(1)
111    </para>
112  </refsect1>
113</refentry>
Note: See TracBrowser for help on using the repository browser.