Changeset 64 for trunk/doc

Timestamp:

07/23/06 12:02:53 (18 years ago)

Author:

tim

Message:

Added reglookup-timeline man page.
Fixed issues in reglookup man page.
Added another reference and updated Makefile.

Location:

trunk/doc

Files:

• Makefile (modified) (3 diffs)
• devel/references.txt (modified) (1 diff)
• reglookup-timeline.1.docbook (added)
• reglookup.1.docbook (modified) (6 diffs, 1 prop)

trunk/doc/Makefile

@@ -1 +1 @@
 # $Id$
 
-BUILD_FILES=$(BUILD_DOC)/man/man1/reglookup.1.gz
+BUILD_FILES=$(BUILD_DOC)/man/man1/reglookup.1.gz $(BUILD_DOC)/man/man1/reglookup-timeline.1.gz
 
 default: $(BUILD_FILES)
@@ -9 +9 @@
         cp man/man1/reglookup.1.gz $@
 
+$(BUILD_DOC)/man/man1/reglookup-timeline.1.gz: man/man1/reglookup-timeline.1.gz
+        mkdir -p $(BUILD_DOC)/man/man1
+        cp man/man1/reglookup-timeline.1.gz $@
+
 install:
         cp -r $(BUILD_DOC)/* $(DOC_PREFIX)
@@ -15 +19 @@
 
 #XXX: Used during release only
-#release:
-#       txt2tags --mask-email -t man -o man/man1/reglookup.1 reglookup.1.t2t
-#       cd man/man1 && gzip -9 reglookup.1
-
 release:
         docbook2x-man --to-stdout reglookup.1.docbook > man/man1/reglookup.1
+        docbook2x-man --to-stdout reglookup-timeline.1.docbook > man/man1/reglookup-timeline.1
         cd man/man1 && gzip -9 -f reglookup.1
+        cd man/man1 && gzip -9 -f reglookup-timeline.1

trunk/doc/devel/references.txt

@@ -3 +3 @@
   (The file 'winntreg.txt' included in this distribution is derived from this.)
   http://home.eunet.no/~pnordahl/ntpasswd/WinReg.txt
+
+- Some useful information on how Windows reads from and writes to registry
+  hives:
+  http://www.microsoft.com/technet/archive/winntas/tips/winntmag/inreg.mspx
+
+- 

trunk/doc/reglookup.1.docbook

@@ -1 +1 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <refentry id='reglookup.1'>
-  <!--  $Id: $ -->
+  <!--  $Id$ -->
   <refmeta>
     <refentrytitle>reglookup</refentrytitle>
@@ -12 +12 @@
   </refnamediv>
 
-  <refsect1 id='syntax'>
+  <refsect1 id='synopsis'>
     <title>SYNOPSIS</title>
     <para>
-      <command>reglookup [options]</command> <replaceable>registry-file</replaceable>
+      <command>
+        reglookup [options] <replaceable>registry-file</replaceable>
+      </command> 
     </para>
   </refsect1>
@@ -30 +32 @@
   </refsect1>
 
-  <refsect1 id='caveats'>
+  <refsect1 id='options'>
     <title>OPTIONS</title>
     <para>
@@ -222 +224 @@
     </para>
     <para>
-      MTIME and SID conversions haven't been checked for accuracy.
+      The SID conversions haven't been carefully checked for accuracy.
+    </para>
+    <para>
+      The MTIME conversions appear correctly produce the stored UTC timestamp.
+      However, due to the periodicity of registry writes, and the complexity
+      of the conversion, a small amount of error (on the order of seconds) may
+      be possible.  The documentation available online from Microsoft on 
+      this field is very poor.
     </para>
     <para>
@@ -231 +240 @@
     <para>
       You'll notice that registry paths aren't all the same as the
-      ones the equivalents you see in the windows registry editor.
-      Don't ask me why that is.  I just work here.
+      equivalents you see in the windows registry editor.  Don't ask me why 
+      that is.  I just work here.
     </para>
     <para>
@@ -266 +275 @@
     </para>
   </refsect1>
+
+  <refsect1 id='seealso'>
+    <title>SEE ALSO</title>
+    <para>
+      reglookup-timeline(1)
+    </para>
+  </refsect1>
 </refentry>