2 # Captive project doc Index page Perl template.
3 # Copyright (C) 2003-2005 Jan Kratochvil <project-www.jankratochvil.net@jankratochvil.net>
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; exactly version 2 of June 1991 is required
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software
16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 package project::captive::doc::Index;
20 require 5.6.0; # at least 'use warnings;' but we need some 5.6.0+ modules anyway
21 our $VERSION=do { my @r=(q$Revision$=~/\d+/g); sprintf "%d.".("%03d"x$#r),@r; };
28 BEGIN { Wuse 'project::captive::doc::Macros'; }
33 project::captive::doc::Macros->init(
34 "title"=>'Captive NTFS Developer Documentation',
35 "rel_next"=>'About.pm',
43 <h1>Captive NTFS Developer Documentation</h1>
47 <li><a href="About.pm">About</a>
49 <li><a href="About.pm#reasons">Reasons for the Implementation</a></li>
50 <li><a href="About.pm#challenges">Challenges of the Project</a></li>
51 <li><a href="About.pm#versions">Microsoft Windows Versions Compatibility</a></li>
54 <li><a href="Architecture.pm">Architecture</a>
56 <li><a href="Architecture.pm#existing_emulation">Existing Emulation Projects</a></li>
57 <li><a href="Architecture.pm#law">Laws and Licensing Conditions</a>
59 <li><a href="Architecture.pm#law_servicepack">Microsoft Service Pack</a></li>
62 <li><a href="Components.pm">Project Components</a></li>
64 <li><a href="Reverse.pm">Reverse Engineering</a>
66 <li><a href="Reverse.pm#dumpbin">dumpbin.exe</a></li>
67 <li><a href="Reverse.pm#WinDbg">WinDbg Windows NT kernel debugging</a>
69 <li><a href="Reverse.pm#WinDbg_WinDbg">WinDbg side setup</a></li>
70 <li><a href="Reverse.pm#WinDbg_kern">Setup of the side being kernel-debugged</a></li>
75 <li><a href="Details.pm">Implementation Details</a>
78 <li><a href="CacheManager.pm">NT Cache Manager</a>
80 <li><a href="CacheManager.pm#TraceFS">TraceFS NT Cache Manager Tracer</a>
82 <li><a href="CacheManager.pm#TraceFS_general">TraceFS for general API tracing</a></li>
86 <li><a href="Details.pm#emulmeth">Choice of the Emulation Methods</a>
88 <li><a href="Details.pm#emulmeth_vm">Virtualmachine Running the Original W32 Subsystem</a></li>
89 <li><a href="Details.pm#method_ntoskrnl">"ntoskrnl.exe" Inside Virtual Address Space</a></li>
90 <li><a href="Details.pm#emulmeth_fs">Filesystem Driver Inside Virtual Address Space</a></li>
92 <li><a href="Details.pm#apichoice">API Function Implementation Choices</a></li>
93 <li><a href="Details.pm#sandbox">Sandboxing of W32 Filesystem</a></li>
94 <li><a href="Details.pm#patched">"patched" vs. "unpatched" Libraries</a></li>
95 <li><a href="Details.pm#mman">Memory Management</a></li>
96 <li><a href="Details.pm#unicode">Unicode Strings and Characters</a></li>
97 <li><a href="Details.pm#binfmt">Supported Binary Formats</a></li>
98 <li><a href="Details.pm#mounted_one">At Most One Mounted Filesystem</a></li>
99 <li><a href="Details.pm#synchronous">Multithreading and Multiple Processors</a></li>
100 <li><a href="Details.pm#paranoia">Paranoia Checks</a></li>
101 <li><a href="Details.pm#logfile">STATUS_LOG_FILE_FULL</a></li>
102 <li><a href="Details.pm#parent_connector">ParentConnector volume remounter</a></li>
104 <li><a href="../apiref/">Captive API Reference Manual (fragment)</a></li>
106 <li><a href="APITypes.pm">API Function Implementation Choices</a>
108 <li><a href="APITypes.pm#functype_pass">Direct Pass to Original "ntoskrnl.exe"</a>
110 <li><a href="APITypes.pm#functype_pass_fromunix">Pass from UNIX Code</a></li>
111 <li><a href="APITypes.pm#functype_pass_fromw32">Pass from W32 Code</a></li>
113 <li><a href="APITypes.pm#functype_wrap">Wrap of the Original "ntoskrnl.exe" Function</a>
115 <li><a href="APITypes.pm#functype_wrap_fromunix">Wrapping of Call from UNIX Code</a></li>
116 <li><a href="APITypes.pm#functype_wrap_fromw32">Wrapping of Call from W32 Code</a></li>
118 <li><a href="APITypes.pm#functype_native">Native Implementation</a>
120 <li><a href="APITypes.pm#functype_native_fromunix">Native Implementation Called from UNIX Code</a></li>
121 <li><a href="APITypes.pm#functype_native_fromw32">Native Implementation of "unpatched"
122 Library Function Called from W32 Code</a></li>
123 <li><a href="APITypes.pm#functype_native_fromw32_patched">Native Implementation of "patched"
124 Library Function Called from W32 Code</a></li>
125 <li><a href="APITypes.pm#functype_native_reactos">Native Implementation - ReactOS</a></li>
126 <li><a href="APITypes.pm#functype_native_wine">Native Implementation – Wine</a></li>
127 <li><a href="APITypes.pm#functype_native_libcaptive">Native Implementation – Project Specific</a></li>
129 <li><a href="APITypes.pm#functype_undef">Undefined Function</a></li>
132 <li><a href="CallType.pm">API Function Calling Conventions</a>
134 <li><a href="CallType.pm#calltype_cdecl">W32 Calling Convention "cdecl"</a></li>
135 <li><a href="CallType.pm#calltype_stdcall">W32 Calling Convention "stdcall"</a></li>
136 <li><a href="CallType.pm#calltype_fastcall">W32 Calling Convention "fastcall"</a></li>
140 <li><a href="TODO.pm#todo_fsck">TODO: Fsck of NTFS</a></li>
141 <li><a href="TODO.pm#todo_surprise">TODO: NTFS Support for Partition Surprise</a></li>
143 <li><a href="Related.pm">Related Projects</a>
145 <li><a href="Related.pm#LinuxNTFScompet">Linux NTFS</a></li>
146 <li><a href="Related.pm#Paragon">Paragon NTFS for Linux</a></li>
147 <li><a href="Related.pm#NTPwd">NTPwd NTFS Driver</a></li>
148 <li><a href="Related.pm#vmware">VMware Workstation</a></li>
149 <li><a href="Related.pm#wine">Wine Project</a></li>
150 <li><a href="Related.pm#ntfs98">NTFS for Windows 98</a></li>
151 <li><a href="Related.pm#ntfsdos">NTFSDOS Professional</a></li>
154 <li><a href="LinuxNTFS.pm">Re: 7.7 Can't we write a wrapper for Windows' driver?</a></li>
162 project::captive::doc::Macros->footer();