--- /dev/null
+# $Id$
+# Captive project doc Index page Perl template.
+# Copyright (C) 2003-2005 Jan Kratochvil <project-www.jankratochvil.net@jankratochvil.net>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; exactly version 2 of June 1991 is required
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+
+package project::captive::doc::Index;
+require 5.6.0; # at least 'use warnings;' but we need some 5.6.0+ modules anyway
+our $VERSION=do { my @r=(q$Revision$=~/\d+/g); sprintf "%d.".("%03d"x$#r),@r; };
+our $CVS_ID=q$Id$;
+use strict;
+use warnings;
+
+use My::Web;
+
+
+sub handler
+{
+ BEGIN { Wuse 'project::captive::doc::Macros'; }
+project::captive::doc::Macros->init(
+ "title"=>'Captive NTFS Developer Documentation',
+ "rel_next"=>'About.pm',
+ "rel_up"=>"..",
+ );
+
+
+print <<"HERE";
+
+
+<h1>Captive NTFS Developer Documentation</h1>
+
+<ul>
+
+<li><a href="About.pm">About</a>
+ <ul>
+ <li><a href="About.pm#reasons">Reasons for the Implementation</a></li>
+ <li><a href="About.pm#challenges">Challenges of the Project</a></li>
+ <li><a href="About.pm#versions">Microsoft Windows Versions Compatibility</a></li>
+ </ul></li>
+
+<li><a href="Architecture.pm">Architecture</a>
+ <ul>
+ <li><a href="Architecture.pm#existing_emulation">Existing Emulation Projects</a></li>
+ <li><a href="Architecture.pm#law">Laws and Licensing Conditions</a>
+ <ul>
+ <li><a href="Architecture.pm#law_servicepack">Microsoft Service Pack</a></li>
+ </ul></li>
+
+ <li><a href="Components.pm">Project Components</a></li>
+
+ <li><a href="Reverse.pm">Reverse Engineering</a>
+ <ul>
+ <li><a href="Reverse.pm#dumpbin">dumpbin.exe</a></li>
+ <li><a href="Reverse.pm#WinDbg">WinDbg Windows NT kernel debugging</a>
+ <ul>
+ <li><a href="Reverse.pm#WinDbg_WinDbg">WinDbg side setup</a></li>
+ <li><a href="Reverse.pm#WinDbg_kern">Setup of the side being kernel-debugged</a></li>
+ </ul></li>
+ </ul></li>
+ </ul></li>
+
+<li><a href="Details.pm">Implementation Details</a>
+
+ <ul>
+ <li><a href="CacheManager.pm">NT Cache Manager</a>
+ <ul>
+ <li><a href="CacheManager.pm#TraceFS">TraceFS NT Cache Manager Tracer</a>
+ <ul>
+ <li><a href="CacheManager.pm#TraceFS_general">TraceFS for general API tracing</a></li>
+ </ul></li>
+ </ul></li>
+
+ <li><a href="Details.pm#emulmeth">Choice of the Emulation Methods</a>
+ <ul>
+ <li><a href="Details.pm#emulmeth_vm">Virtualmachine Running the Original W32 Subsystem</a></li>
+ <li><a href="Details.pm#method_ntoskrnl">"ntoskrnl.exe" Inside Virtual Address Space</a></li>
+ <li><a href="Details.pm#emulmeth_fs">Filesystem Driver Inside Virtual Address Space</a></li>
+ </ul></li>
+ <li><a href="Details.pm#apichoice">API Function Implementation Choices</a></li>
+ <li><a href="Details.pm#sandbox">Sandboxing of W32 Filesystem</a></li>
+ <li><a href="Details.pm#patched">"patched" vs. "unpatched" Libraries</a></li>
+ <li><a href="Details.pm#mman">Memory Management</a></li>
+ <li><a href="Details.pm#unicode">Unicode Strings and Characters</a></li>
+ <li><a href="Details.pm#binfmt">Supported Binary Formats</a></li>
+ <li><a href="Details.pm#mounted_one">At Most One Mounted Filesystem</a></li>
+ <li><a href="Details.pm#synchronous">Multithreading and Multiple Processors</a></li>
+ <li><a href="Details.pm#paranoia">Paranoia Checks</a></li>
+ <li><a href="Details.pm#logfile">STATUS_LOG_FILE_FULL</a></li>
+ <li><a href="Details.pm#parent_connector">ParentConnector volume remounter</a></li>
+
+ <li><a href="../apiref/">Captive API Reference Manual (fragment)</a></li>
+
+ <li><a href="APITypes.pm">API Function Implementation Choices</a>
+ <ul>
+ <li><a href="APITypes.pm#functype_pass">Direct Pass to Original "ntoskrnl.exe"</a>
+ <ul>
+ <li><a href="APITypes.pm#functype_pass_fromunix">Pass from UNIX Code</a></li>
+ <li><a href="APITypes.pm#functype_pass_fromw32">Pass from W32 Code</a></li>
+ </ul></li>
+ <li><a href="APITypes.pm#functype_wrap">Wrap of the Original "ntoskrnl.exe" Function</a>
+ <ul>
+ <li><a href="APITypes.pm#functype_wrap_fromunix">Wrapping of Call from UNIX Code</a></li>
+ <li><a href="APITypes.pm#functype_wrap_fromw32">Wrapping of Call from W32 Code</a></li>
+ </ul></li>
+ <li><a href="APITypes.pm#functype_native">Native Implementation</a>
+ <ul>
+ <li><a href="APITypes.pm#functype_native_fromunix">Native Implementation Called from UNIX Code</a></li>
+ <li><a href="APITypes.pm#functype_native_fromw32">Native Implementation of "unpatched"
+ Library Function Called from W32 Code</a></li>
+ <li><a href="APITypes.pm#functype_native_fromw32_patched">Native Implementation of "patched"
+ Library Function Called from W32 Code</a></li>
+ <li><a href="APITypes.pm#functype_native_reactos">Native Implementation - ReactOS</a></li>
+ <li><a href="APITypes.pm#functype_native_wine">Native Implementation – Wine</a></li>
+ <li><a href="APITypes.pm#functype_native_libcaptive">Native Implementation – Project Specific</a></li>
+ </ul></li>
+ <li><a href="APITypes.pm#functype_undef">Undefined Function</a></li>
+ </ul></li>
+
+ <li><a href="CallType.pm">API Function Calling Conventions</a>
+ <ul>
+ <li><a href="CallType.pm#calltype_cdecl">W32 Calling Convention "cdecl"</a></li>
+ <li><a href="CallType.pm#calltype_stdcall">W32 Calling Convention "stdcall"</a></li>
+ <li><a href="CallType.pm#calltype_fastcall">W32 Calling Convention "fastcall"</a></li>
+ </ul></li>
+ </ul></li>
+
+<li><a href="TODO.pm#todo_fsck">TODO: Fsck of NTFS</a></li>
+<li><a href="TODO.pm#todo_surprise">TODO: NTFS Support for Partition Surprise</a></li>
+
+<li><a href="Related.pm">Related Projects</a>
+ <ul>
+ <li><a href="Related.pm#LinuxNTFScompet">Linux NTFS</a></li>
+ <li><a href="Related.pm#Paragon">Paragon NTFS for Linux</a></li>
+ <li><a href="Related.pm#NTPwd">NTPwd NTFS Driver</a></li>
+ <li><a href="Related.pm#vmware">VMware Workstation</a></li>
+ <li><a href="Related.pm#wine">Wine Project</a></li>
+ <li><a href="Related.pm#ntfs98">NTFS for Windows 98</a></li>
+ <li><a href="Related.pm#ntfsdos">NTFSDOS Professional</a></li>
+ </ul></li>
+
+<li><a href="LinuxNTFS.pm">Re: 7.7 Can't we write a wrapper for Windows' driver?</a></li>
+
+</ul>
+
+
+HERE
+
+
+exit;
+}
+1;
git://git.jankratochvil.net / www.jankratochvil.net.git / blobdiff