project/captive/doc/Index.html.pl

   1 #! /usr/bin/perl
   2 #
   3 # $Id$
   4 # Captive project doc Index page Perl template.
   5 # Copyright (C) 2003 Jan Kratochvil <project-www.jankratochvil.net@jankratochvil.net>
   6 #
   7 # This program is free software; you can redistribute it and/or modify
   8 # it under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; exactly version 2 of June 1991 is required
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with this program; if not, write to the Free Software
  18 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19
  20
  21 package project::captive::doc::Index;
  22 require 5.6.0;  # at least 'use warnings;' but we need some 5.6.0+ modules anyway
  23 our $VERSION=do { my @r=(q$Revision$=~/\d+/g); sprintf "%d.".("%03d"x$#r),@r; };
  24 our $CVS_ID=q$Id$;
  25 use strict;
  26 use warnings;
  27
  28 BEGIN{ open F,"Makefile"; our $top_dir=pop @{[split /\s/,(grep /^top_srcdir/,<F>)[0]]}; eval "use lib '$top_dir'"; close F; }
  29 use My::Web;
  30 require CGI;
  31 BEGIN { Wuse 'project::captive::doc::Macros'; }
  32
  33
  34 project::captive::doc::Macros->init(
  35                 "__PACKAGE__"=>__PACKAGE__,
  36                 "title"=>'Captive NTFS Developer Documentation',
  37                 "rel_next"=>'About.html.pl',
  38                 "rel_up"=>top_dir("/project/captive/"),
  39                 );
  40
  41
  42 print <<"HERE";
  43
  44
  45 <h1>Captive NTFS Developer Documentation</h1>
  46
  47 <ul>
  48
  49 <li><a href="About.html.pl">About</a>
  50         <ul>
  51         <li><a href="About.html.pl#reasons">Reasons for the Implementation</a></li>
  52         <li><a href="About.html.pl#challenges">Challenges of the Project</a></li>
  53         <li><a href="About.html.pl#versions">Microsoft Windows Versions Compatibility</a></li>
  54         </ul></li>
  55
  56 <li><a href="Architecture.html.pl">Architecture</a>
  57         <ul>
  58         <li><a href="Architecture.html.pl#existing_emulation">Existing Emulation Projects</a></li>
  59         <li><a href="Architecture.html.pl#law">Laws and Licensing Conditions</a>
  60                 <ul>
  61                 <li><a href="Architecture.html.pl#law_servicepack">Microsoft Service Pack</a></li>
  62                 </ul></li>
  63
  64         <li><a href="Components.html.pl">Project Components</a></li>
  65
  66         <li><a href="Reverse.html.pl">Reverse Engineering</a>
  67                 <ul>
  68                 <li><a href="Reverse.html.pl#dumpbin">dumpbin.exe</a></li>
  69                 <li><a href="Reverse.html.pl#WinDbg">WinDbg Windows NT kernel debugging</a>
  70                         <ul>
  71                         <li><a href="Reverse.html.pl#WinDbg_WinDbg">WinDbg side setup</a></li>
  72                         <li><a href="Reverse.html.pl#WinDbg_kern">Setup of the side being kernel-debugged</a></li>
  73                         </ul></li>
  74                 </ul></li>
  75         </ul></li>
  76
  77 <li><a href="Details.html.pl">Implementation Details</a>
  78
  79         <ul>
  80         <li><a href="CacheManager.html.pl">NT Cache Manager</a>
  81                 <ul>
  82                 <li><a href="CacheManager.html.pl#TraceFS">TraceFS NT Cache Manager Tracer</a>
  83                         <ul>
  84                         <li><a href="CacheManager.html.pl#TraceFS_general">TraceFS for general API tracing</a></li>
  85                         </ul></li>
  86                 </ul></li>
  87
  88         <li><a href="Details.html.pl#emulmeth">Choice of the Emulation Methods</a>
  89                 <ul>
  90                 <li><a href="Details.html.pl#emulmeth_vm">Virtualmachine Running the Original W32 Subsystem</a></li>
  91                 <li><a href="Details.html.pl#method_ntoskrnl">&quot;ntoskrnl.exe&quot; Inside Virtual Address Space</a></li>
  92                 <li><a href="Details.html.pl#emulmeth_fs">Filesystem Driver Inside Virtual Address Space</a></li>
  93                 </ul></li>
  94         <li><a href="Details.html.pl#apichoice">API Function Implementation Choices</a></li>
  95         <li><a href="Details.html.pl#sandbox">Sandboxing of W32 Filesystem</a></li>
  96         <li><a href="Details.html.pl#patched">&quot;patched&quot; vs. &quot;unpatched&quot; Libraries</a></li>
  97         <li><a href="Details.html.pl#mman">Memory Management</a></li>
  98         <li><a href="Details.html.pl#unicode">Unicode Strings and Characters</a></li>
  99         <li><a href="Details.html.pl#binfmt">Supported Binary Formats</a></li>
 100         <li><a href="Details.html.pl#mounted_one">At Most One Mounted Filesystem</a></li>
 101         <li><a href="Details.html.pl#synchronous">Multithreading and Multiple Processors</a></li>
 102         <li><a href="Details.html.pl#paranoia">Paranoia Checks</a></li>
 103         <li><a href="Details.html.pl#logfile">STATUS_LOG_FILE_FULL</a></li>
 104         <li><a href="Details.html.pl#parent_connector">ParentConnector volume remounter</a></li>
 105
 106         <li><a href="../apiref/">Captive API Reference Manual (fragment)</a></li>
 107
 108         <li><a href="APITypes.html.pl">API Function Implementation Choices</a>
 109                 <ul>
 110                 <li><a href="APITypes.html.pl#functype_pass">Direct Pass to Original &quot;ntoskrnl.exe&quot;</a>
 111                         <ul>
 112                         <li><a href="APITypes.html.pl#functype_pass_fromunix">Pass from UNIX Code</a></li>
 113                         <li><a href="APITypes.html.pl#functype_pass_fromw32">Pass from W32 Code</a></li>
 114                         </ul></li>
 115                 <li><a href="APITypes.html.pl#functype_wrap">Wrap of the Original "ntoskrnl.exe" Function</a>
 116                         <ul>
 117                         <li><a href="APITypes.html.pl#functype_wrap_fromunix">Wrapping of Call from UNIX Code</a></li>
 118                         <li><a href="APITypes.html.pl#functype_wrap_fromw32">Wrapping of Call from W32 Code</a></li>
 119                         </ul></li>
 120                 <li><a href="APITypes.html.pl#functype_native">Native Implementation</a>
 121                         <ul>
 122                         <li><a href="APITypes.html.pl#functype_native_fromunix">Native Implementation Called from UNIX Code</a></li>
 123                         <li><a href="APITypes.html.pl#functype_native_fromw32">Native Implementation of &quot;unpatched&quot;
 124                                         Library Function Called from W32 Code</a></li>
 125                         <li><a href="APITypes.html.pl#functype_native_fromw32_patched">Native Implementation of &quot;patched&quot;
 126                                         Library Function Called from W32 Code</a></li>
 127                         <li><a href="APITypes.html.pl#functype_native_reactos">Native Implementation - ReactOS</a></li>
 128                         <li><a href="APITypes.html.pl#functype_native_wine">Native Implementation &ndash; Wine</a></li>
 129                         <li><a href="APITypes.html.pl#functype_native_libcaptive">Native Implementation &ndash; Project Specific</a></li>
 130                         </ul></li>
 131                 <li><a href="APITypes.html.pl#functype_undef">Undefined Function</a></li>
 132                 </ul></li>
 133
 134         <li><a href="CallType.html.pl">API Function Calling Conventions</a>
 135                 <ul>
 136                 <li><a href="CallType.html.pl#calltype_cdecl">W32 Calling Convention &quot;cdecl&quot;</a></li>
 137                 <li><a href="CallType.html.pl#calltype_stdcall">W32 Calling Convention &quot;stdcall&quot;</a></li>
 138                 <li><a href="CallType.html.pl#calltype_fastcall">W32 Calling Convention &quot;fastcall&quot;</a></li>
 139                 </ul></li>
 140         </ul></li>
 141
 142 <li><a href="TODO.html.pl#todo_fsck">TODO: Fsck of NTFS</a></li>
 143 <li><a href="TODO.html.pl#todo_surprise">TODO: NTFS Support for Partition Surprise</a></li>
 144
 145 <li><a href="Related.html.pl">Related Projects</a>
 146         <ul>
 147         <li><a href="Related.html.pl#LinuxNTFScompet">Linux NTFS</a></li>
 148         <li><a href="Related.html.pl#NTPwd">NTPwd NTFS Driver</a></li>
 149         <li><a href="Related.html.pl#vmware">VMware Workstation</a></li>
 150         <li><a href="Related.html.pl#wine">Wine Project</a></li>
 151         <li><a href="Related.html.pl#ntfs98">NTFS for Windows 98</a></li>
 152         <li><a href="Related.html.pl#ntfsdos">NTFSDOS Professional</a></li>
 153         </ul></li>
 154
 155 <li><a href="LinuxNTFS.html.pl">Re: 7.7 Can't we write a wrapper for Windows' driver?</a></li>
 156
 157 </ul>
 158
 159
 160 HERE
 161
 162
 163 project::captive::doc::Macros->footer();