#! /usr/bin/perl
# 
# $Id$
# Captive project doc Index page Perl template.
# Copyright (C) 2003 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;

BEGIN{ open F,"Makefile"; our $top_dir=pop @{[split /\s/,(grep /^top_srcdir/,<F>)[0]]}; eval "use lib '$top_dir'"; close F; }
use My::Web;
require "CGI";
use project::captive::doc::Macros;


My::Web->init(
		"__PACKAGE__"=>__PACKAGE__,
		"title"=>'Captive NTFS Developer Documentation',
		"head_css"=>$doc_Macros_head_css,
		);
My::Web->heading();


print <<"HERE";


<h1>Captive NTFS Developer Documentation</h1>


<ul>

<li><a href="About.html.pl">About</a>
	<ul>
	<li><a href="About.html.pl#reasons">Reasons for the Implementation</a></li>
	<li><a href="About.html.pl#challenges">Challenges of the Project</a></li>
	<li><a href="About.html.pl#versions">Microsoft Windows Versions Compatibility</a></li>
	</ul></li>

<li><a href="Architecture.html.pl">Architecture</a>
	<ul>
	<li><a href="Architecture.html.pl#existing_emulation">Existing Emulation Projects</a></li>
	<li><a href="Architecture.html.pl#law">Laws and Licensing Conditions</a>
		<ul>
		<li><a href="Architecture.html.pl#law_servicepack">Microsoft Service Pack</a></li>
		</ul></li>

	<li><a href="Components.html.pl">Project Components</a></li>

	<li><a href="Reverse.html.pl">Reverse Engineering</a>
		<ul>
		<li><a href="Reverse.html.pl#dumpbin">dumpbin.exe</a></li>
		<li><a href="Reverse.html.pl#WinDbg">WinDbg Windows NT kernel debugging</a>
			<ul>
			<li><a href="Reverse.html.pl#WinDbg_WinDbg">WinDbg side setup</a></li>
			<li><a href="Reverse.html.pl#WinDbg_kern">Setup of the side being kernel-debugged</a></li>
			</ul></li>
		</ul></li>
	</ul></li>

<li><a href="Details.html.pl">Implementation Details</a>

	<ul>
	<li><a href="CacheManager.html.pl">NT Cache Manager</a>
		<ul>
		<li><a href="CacheManager.html.pl#TraceFS">TraceFS NT Cache Manager Tracer</a>
			<ul>
			<li><a href="CacheManager.html.pl#TraceFS_general">TraceFS for general API tracing</a></li>
			</ul></li>
		</ul></li>

	<li><a href="Details.html.pl#emulmeth">Choice of the Emulation Methods</a>
		<ul>
		<li><a href="Details.html.pl#emulmeth_vm">Virtualmachine Running the Original W32 Subsystem</a></li>
		<li><a href="Details.html.pl#method_ntoskrnl">&quot;ntoskrnl.exe&quot; Inside Virtual Address Space</a></li>
		<li><a href="Details.html.pl#emulmeth_fs">Filesystem Driver Inside Virtual Address Space</a></li>
		</ul></li>
	<li><a href="Details.html.pl#apichoice">API Function Implementation Choices</a></li>
	<li><a href="Details.html.pl#sandbox">Sandboxing of W32 filesystem</a></li>
	<li><a href="Details.html.pl#patched">&quot;patched&quot; vs. &quot;unpatched&quot; Libraries</a></li>
	<li><a href="Details.html.pl#mman">Memory Management</a></li>
	<li><a href="Details.html.pl#unicode">Unicode Strings and Characters</a></li>
	<li><a href="Details.html.pl#binfmt">Supported Binary Formats</a></li>
	<li><a href="Details.html.pl#mounted_one">At Most One Mounted Filesystem</a></li>
	<li><a href="Details.html.pl#synchronous">Multithreading and Multiple Processors</a></li>
	<li><a href="Details.html.pl#paranoia">Paranoia Checks</a></li>
	<li><a href="Details.html.pl#logfile">STATUS_LOG_FILE_FULL</a></li>
	<li><a href="Details.html.pl#parent_connector">ParentConnector volume remounter</a></li>

	<li><a href="APITypes.html.pl">API Function Implementation Choices</a>
		<ul>
		<li><a href="APITypes.html.pl#functype_pass">Direct Pass to Original &quot;ntoskrnl.exe&quot;</a>
			<ul>
			<li><a href="APITypes.html.pl#functype_pass_fromunix">Pass from UNIX Code</a></li>
			<li><a href="APITypes.html.pl#functype_pass_fromw32">Pass from W32 Code</a></li>
			</ul></li>
		<li><a href="APITypes.html.pl#functype_wrap">Wrap of the Original "ntoskrnl.exe" Function</a>
			<ul>
			<li><a href="APITypes.html.pl#functype_wrap_fromunix">Wrapping of Call from UNIX Code</a></li>
			<li><a href="APITypes.html.pl#functype_wrap_fromw32">Wrapping of Call from W32 Code</a></li>
			</ul></li>
		<li><a href="APITypes.html.pl#functype_native">Native Implementation</a>
			<ul>
			<li><a href="APITypes.html.pl#functype_native_fromunix">Native Implementation Called from UNIX Code</a></li>
			<li><a href="APITypes.html.pl#functype_native_fromw32">Native Implementation of &quot;unpatched&quot;
					Library Function Called from W32 Code</a></li>
			<li><a href="APITypes.html.pl#functype_native_fromw32_patched">Native Implementation of &quot;patched&quot;
					Library Function Called from W32 Code</a></li>
			<li><a href="APITypes.html.pl#functype_native_reactos">Native Implementation - ReactOS</a></li>
			<li><a href="APITypes.html.pl#functype_native_wine">Native Implementation &ndash; Wine</a></li>
			<li><a href="APITypes.html.pl#functype_native_libcaptive">Native Implementation &ndash; Project Specific</a></li>
			</ul></li>
		<li><a href="APITypes.html.pl#functype_undef">Undefined Function</a></li>
		</ul></li>

	<li><a href="CallType.html.pl">API Function Calling Conventions</a>
		<ul>
		<li><a href="CallType.html.pl#calltype_cdecl">W32 Calling Convention &quot;cdecl&quot;</a></li>
		<li><a href="CallType.html.pl#calltype_stdcall">W32 Calling Convention &quot;stdcall&quot;</a></li>
		<li><a href="CallType.html.pl#calltype_fastcall">W32 Calling Convention &quot;fastcall&quot;</a></li>
		</ul></li>
	</ul></li>

<li><a href="TODO.html.pl#todo_fsck">TODO: Fsck of NTFS</a></li>
<li><a href="TODO.html.pl#todo_surprise">TODO: NTFS Support for Partition Surprise</a></li>

<li><a href="Related.html.pl">Related Projects</a>
	<ul>
	<li><a href="Related.html.pl#LinuxNTFScompet">Linux NTFS</a></li>
	<li><a href="Related.html.pl#NTPwd">NTPwd NTFS Driver</a></li>
	<li><a href="Related.html.pl#vmware">VMware Workstation</a></li>
	<li><a href="Related.html.pl#wine">Wine Project</a></li>
	<li><a href="Related.html.pl#ntfs98">NTFS for Windows 98</a></li>
	<li><a href="Related.html.pl#ntfsdos">NTFSDOS Professional</a></li>
	</ul></li>

<li><a href="LinuxNTFS.html.pl">Re: 7.7 Can't we write a wrapper for Windows' driver?</a></li>

</ul>


HERE


My::Web->footer();
