project/captive/Index.html.pl

   1 #! /usr/bin/perl
   2 #
   3 # $Id$
   4 # Main page of 'My::Project::captive'
   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::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 Wuse 'My::Project';
  31 Wuse 'project::captive::ListItem';
  32
  33
  34 my $W=My::Project->init_project(
  35                 "__PACKAGE__"=>__PACKAGE__,
  36                 "ListItem"=>\@project::captive::ListItem::ListItem,
  37                 "head_css"=>"
  38 .reqpkg { font-style: italic; }
  39 .stuff  { font-style: italic; font-size: larger; margin-left: 20%; margin-right: 10%; }
  40 .re     { font-style: italic; }
  41 ",
  42                 );
  43
  44
  45 print vskip("10ex")."<h1 align=\"center\">!!! DO NOT DISCLOSE !!!</h1>\n".vskip("10ex");
  46
  47 print <<"HERE";
  48 <h1>The First Read/Write NTFS for Free Operating Systems</h1>
  49 <h1>The First Free Microsoft Windows Kernel API Emulation</h1>
  50 HERE
  51
  52 my @stuff=(
  53                 "A lot of people claim themselves as Windows Programmers.\n"
  54                                 ." Now I can finally join them - I also wrote my own Microsoft Windows.",
  55                 "Why do they need ".a_href('http://www.winsupersite.com/reviews/winserver2k3_gold2.asp','5000 developers')
  56                                 ." to write Microsoft Windows when it is just One Man Show task?",
  57
  58
  59
  60                 "My first Microsoft Windows program ever written? Some 'helloworld'?"
  61                                 ." <span class=\"quote\">hal.dll</span>.",
  62                 );
  63
  64
  65 print <<"HERE";
  66
  67
  68 <table border="0" width="100%">
  69         <col width="1*" />
  70         <col width="0*" />
  71         <tr>
  72                 <td align="left">
  73                         @{[ map("<p class=\"stuff\">$_</p>\n",($stuff[int rand @stuff])) ]}
  74                 </td>
  75                 <td align="right">@{[ a_href My::Web::img_src('captive-install-acquire'),
  76                                 img('captive-install-acquire-small','[ Captive Microsoft Windows Drivers Acquire Illustration ]') ]}</td>
  77         </tr>
  78 </table>
  79
  80 @{[ vskip "3ex" ]}
  81
  82 <table border="1" align="center" style="text-align: center;"><tr><th>Distribution</th>
  83                 <th>Installation Case #1<br />Filesystem and installer<br />(recommended)</th>
  84                 <th>Installation Case #2<br />Manual installation<br />(filesystem, expert user)</th>
  85                 <th>Installation Case #3<br />Command-line client<br />(no filesystem access)</th></tr>
  86 HERE
  87 my %pkg=(
  88                 1=>[qw(captive captive-lufs captive-install lufs gnome-vfs-httpcaptive ntfsprogs ntfsprogs-gnomevfs)],
  89                 2=>[qw(captive captive-lufs                 lufs)],
  90                 3=>[qw(captive)],
  91                 );
  92 my %reqpkg=(
  93                 1=>[qw(glib2 gnome-vfs2 ORBit2 libxml2 openssl popt          libgnomeui)],
  94                 2=>[qw(glib2 gnome-vfs2 ORBit2 libxml2 openssl popt)],
  95                 3=>[qw(glib2 gnome-vfs2 ORBit2 libxml2 openssl popt readline)],
  96                 );
  97 my %version=(
  98                 map(($_=>["0.9.4","0"]),qw(captive captive-lufs captive-install)),
  99                 "lufs"=>["0.9.6","1captive3"],
 100                 "gnome-vfs-httpcaptive"=>["2.3.8captive2","0"],
 101                 "ntfsprogs"=>["200309071734","1captive1"],
 102                 "ntfsprogs-gnomevfs"=>["1.0.1","0"],
 103                 );
 104 my %has_rh8=(map(($_=>1),qw(
 105                 gnome-vfs-httpcaptive
 106                 captive
 107                 captive-lufs
 108                 captive-install
 109                 )));
 110 my %has_mdk91=(map(($_=>1),qw(
 111                 gnome-vfs-httpcaptive
 112                 lufs
 113                 captive
 114                 captive-lufs
 115                 captive-install
 116                 )));
 117 my %has_devel=(map(($_=>1),qw(
 118                 ntfsprogs
 119                 )));
 120 my %pkg_nosrc=(map(($_=>1),qw(
 121                 captive-lufs
 122                 captive-install
 123                 )));
 124
 125 my $case;
 126 my $a_href_arch=sub ($$%)
 127 {
 128 my($file_base,$text,%args)=@_;
 129
 130         $text=~s/[._]\D.*$// if $case!=1 && $text!~/^[.]/;
 131         return a_href $file_base,$text,"size"=>($case==1),%args;
 132 };
 133
 134 my @dist=(
 135                 {
 136                         "name"=>"Red Hat 9<br />Shrike i386",
 137                         "out"=>sub {
 138                                 my($pkg,$version_base,$version_ext)=@_;
 139                                         my $file="$pkg-$version_base-$version_ext.i386.rpm";
 140                                         my $r=&$a_href_arch("dist/$file",$file);
 141                                         (my $filedev=$file)=~s/^\Q$pkg\E-/${pkg}-devel-/;
 142                                         $r.="<br />".&$a_href_arch("dist/$filedev",$filedev) if $has_devel{$pkg};
 143                                         return $r;
 144                                 },
 145                         },
 146                 {
 147                         "name"=>"Red Hat 8<br />Psyche i386",
 148                         "out"=>sub {
 149                                 my($pkg,$version_base,$version_ext)=@_;
 150                                         my $file="$pkg-$version_base-$version_ext".(!$has_rh8{$pkg} ? "" : "rh8").".i386.rpm";
 151                                         my $r=&$a_href_arch("dist/$file",$file);
 152                                         (my $filedev=$file)=~s/^\Q$pkg\E-/${pkg}-devel-/;
 153                                         $r.="<br />".&$a_href_arch("dist/$filedev",$filedev) if $has_devel{$pkg};
 154                                         if ($pkg eq "captive-install") {
 155                                                 for (qw(libxml2-2.5.4-1.i386.rpm libxml2-python-2.5.4-1.i386.rpm libxml2-devel-2.5.4-1.i386.rpm)) {
 156                                                         $r.="<br />".&$a_href_arch('ftp://ftp.redhat.com/pub/redhat/linux/9/en/os/i386/RedHat/RPMS/'.$_,$_)." of Red Hat 9";
 157                                                         }
 158                                                 }
 159                                         return $r;
 160                                 },
 161                         },
 162                 {
 163                         "name"=>"Mandrake 9.1<br />Bamboo i586",
 164                         "out"=>sub {
 165                                 my($pkg,$version_base,$version_ext)=@_;
 166                                         my $file="$pkg-$version_base-$version_ext".(!$has_mdk91{$pkg} ? ".i386.rpm" : "mdk91.i586.rpm");
 167                                         my $r=&$a_href_arch("dist/$file",$file);
 168                                         (my $filedev=$file)=~s/^\Q$pkg\E-/${pkg}-devel-/;
 169                                         $r.="<br />".&$a_href_arch("dist/$filedev",$filedev) if $has_devel{$pkg};
 170                                         return $r;
 171                                 },
 172                         },
 173                 {
 174                         "name"=>"Debian GNU/Linux<br />'unstable' i386",
 175                         "out"=>sub {
 176                                 my($pkg,$version_base,$version_ext)=@_;
 177                                         $version_ext=~s/^\d+//;
 178                                         my $file="${pkg}_$version_base".($version_ext=~/^\d+$/ ? "" : $version_ext)."_i386.deb";
 179                                         my $r=&$a_href_arch("dist/$file",$file);
 180                                         (my $filedev=$file)=~s/^\Q$pkg\E_/${pkg}-dev_/;
 181                                         $r.="<br />".&$a_href_arch("dist/$filedev",$filedev) if $has_devel{$pkg};
 182                                         return $r;
 183                                 },
 184                         },
 185                 {
 186                         "name"=>"Sources (.tar.gz)",
 187                         "out"=>sub {
 188                                 my($pkg,$version_base,$version_ext)=@_;
 189                                         return () if $pkg_nosrc{$pkg};
 190                                         $version_ext=~s/^\d+//;
 191                                         my $file="$pkg-$version_base".($version_ext=~/^\d+$/ ? "" : $version_ext).".tar.gz";
 192                                         return $file,$file;
 193                                 },
 194                         },
 195                 {
 196                         "name"=>"Sources (.src.rpm)<br />(Red Hat 9 - Shrike)",
 197                         "out"=>sub {
 198                                 my($pkg,$version_base,$version_ext)=@_;
 199                                         return () if $pkg_nosrc{$pkg};
 200                                         my $file="$pkg-$version_base-$version_ext.src.rpm";
 201                                         return $file,$file;
 202                                 },
 203                         },
 204                 );
 205
 206 for my $dist (@dist) {
 207         print "<tr>";
 208                 print "<td>".$dist->{"name"}."</td>";
 209                 for my $casel (1,2,3) {
 210                         $case=$casel;
 211                         print "<td>";
 212                         print join("<br />",map({ my $pkg=$_;
 213                                 my($file,$text)=&{$dist->{"out"}}($pkg,@{$version{$pkg}});
 214                                 (!defined $text ? ($file) || () : (&$a_href_arch("dist/$file",$text)));
 215                                 } @{$pkg{$case}}));
 216                         print "</td>";
 217                         }
 218         print "</tr>\n";
 219         }
 220 print <<'HERE';
 221 </table>
 222 HERE
 223
 224 print vskip "3ex";
 225
 226 print <<"HERE";
 227 <h1>Installation notes</h1>
 228
 229 <p>You should first run <b>captive-install-acquire</b> command to check your
 230 available Microsoft Windows drivers versions. Now you can execute:</p>
 231
 232 <blockquote>
 233         <p class="quote">
 234                 # mkdir /mnt/dosc<br />
 235                 # mount -t captive-ntfs /dev/hda1 /mnt/dosc
 236         </p>
 237 </blockquote>
 238
 239
 240 <h2>Overview</h2>
 241
 242 <p>'<b>captive</b>' is the base package. It contains debugging '<b>captive-cmdline</b>' client.<br />
 243 '<b>captive-lufs</b>' permits mounting NTFS as regular filesystem. It needs '<b>lufs</b>'.<br />
 244 '<b>lufs</b>' is a daemon to enable userland process to provide filesystem functions.</p>
 245
 246 <p>Any errors from '<b>captive-lufs</b>' are written to '<b>/var/log/messages</b>'.</p>
 247
 248 <p>Needed drivers (at least ntoskrnl.exe+ntfs.sys) must be in '<b>/var/lib/captive</b>'.</p>
 249
 250 <p>'<b>captive</b>' package creates '<b>captive</b>' user and '<b>captive</b>' group on your system.</p>
 251
 252
 253 <h2>Package version conflicts</h2>
 254
 255 <dl>
 256
 257 <dt>@{[ a_href 'http://lufs.sourceforge.net/lufs/','lufs' ]}</dt>
 258 <dd><p><b>'captive' version required</b>: Although you may already have the
 259 original package installed you must replace it by the local 'captive'-marked
 260 version containing some 'captive'-essential fixes and extensions.</p></dd>
 261
 262 <dt>@{[ a_href 'http://linux-ntfs.sourceforge.net/','ntfsprogs' ]}</dt>
 263 <dd><p><b>Original version >=200309071734 sufficient</b>:
 264 The package downloadable here has no code patches - you can freely use the
 265 original version instead.  Unfortunately the last public release is
 266 <b>1.7.1</b> while this project requires at least
 267 @{[ a_href 'http://linux-ntfs.sourceforge.net/snapshots/','snapshot' ]} version
 268 <b>@{[ a_href 'http://linux-ntfs.sourceforge.net/snapshots/ntfsprogs-200309071734.tar.bz2','200309071734' ]}</b>
 269 which is not packaged (.rpm/.deb) yet. Packaged versions are provided here for
 270 your convenience.</p></dd>
 271
 272 </dl>
 273
 274
 275 <h2>LUFS kernel driver module</h2>
 276
 277 <p>@{[ a_href 'http://lufs.sourceforge.net/lufs/','LUFS' ]} (Linux Userland File
 278 System) needs Linux kernel module driver (<i>lufs.o</i>) compatible with your
 279 running Linux kernel. Binary driver is supplied already precompiled for many
 280 Linux kernel versions in the binary packages above (<b>.i386.rpm</b> and
 281 <b>_i386.deb</b> archives).</p>
 282
 283 <p>If you cannot <b>mount</b>(8) your NTFS filesystem you should run <span
 284 class="quote">/usr/share/lufs/prepmod</span> to see the reasons. It is always
 285 recommended to upgrade to the latest stable kernel supplied by your GNU/Linux
 286 distribution vendor. You may need to install package
 287 <b>kernel-source</b> (Red Hat) or <b>kernel-headers</b> (Debian) matching your
 288 Linux kernel version (<b>rpm&nbsp;-q&nbsp;kernel</b>) and re-run <span
 289 class="quote">/usr/share/lufs/prepmod</span>.</p>
 290
 291
 292 <table border="0" width="100%">
 293         <col width="1*" />
 294         <col width="0*" />
 295         <tr>
 296                 <td align="left">
 297                         <h2>The First Free Microsoft Windows Kernel API Emulation</h2>
 298
 299                         <p>Compatibility with existing binary Microsoft Windows file system drivers was
 300                         reached. Microsoft Windows kernel system components required by these drivers
 301                         were analyzed and successfuly emulated in the GNU/Linux operating system.
 302                         Project brings Microsoft Windows kernel emulation framework to support even
 303                         other types Microsoft Windows drivers in the future.
 304                         <span class="productname">@{[ a_href 'http://www.reactos.com/','ReactOS' ]}</span>
 305                         code base made a big asset for this functionality.</p>
 306                 </td>
 307                 <td align="right">@{[ a_href 'http://www.reactos.com/',img('reactos','ReactOS') ]}</td>
 308         </tr>
 309 </table>
 310
 311
 312 @{[ vskip "3ex" ]}
 313
 314 <h1>See also</h1>
 315 <ul>
 316         <li>@{[ a_href 'Preview.html.pl','Technology Preview' ]}</li>
 317         <li>@{[ a_href 'doc/','Developer Documentation' ]}; highlights:<ul>
 318                 <li>@{[ a_href 'doc/About.html.pl#versions','Microsoft Windows Versions Compatibility' ]}</li>
 319                 <li>@{[ a_href 'doc/Architecture.html.pl#law','Laws and Licensing Conditions' ]}</li>
 320                 <li>@{[ a_href 'doc/Details.html.pl#sandbox','Sandboxing of W32 filesystem' ]}</li>
 321                 <li>@{[ a_href 'doc/TODO.html.pl#todo_fsck','TODO: Fsck of NTFS' ]}</li>
 322                 <li>@{[ a_href 'doc/TODO.html.pl#todo_surprise','TODO: NTFS Support for Partition Surprise' ]}</li>
 323                 <li>@{[ a_href 'doc/Related.html.pl#LinuxNTFScompet','Related Projects - Linux NTFS' ]}</li>
 324                 <li>@{[ a_href 'doc/Related.html.pl#vmware','Related Projects - VMware Workstation' ]}</li>
 325                 <li>@{[ a_href 'doc/LinuxNTFS.html.pl',"Re: 7.7 Can't we write a wrapper for Windows' driver?" ]}</li>
 326                 </ul></li>
 327         <li>@{[ a_href 'http://cvs.jankratochvil.net/viewcvs/*checkout*/priv/captive/TODO?rev=HEAD','Known Bugs' ]}</li>
 328         <li>Man pages<ul>
 329                 @{[
 330                         do {
 331                                 my @mans=(
 332                                                 'captive'=>[7,'Microsoft Windows NT kernel emulation for NTFS disk access'],
 333                                                 'mount.captive'=>[8,'mount(8) interface for NTFS disk access'],
 334                                                 'lufs-captivefs'=>[7,'Linux Userland File System module for NTFS as filesystem'],
 335                                                 'captive-cmdline'=>[1,'Command-line client for captive(7) NTFS disk access'],
 336 ###                                             'captive-sandbox-server'=>[1,'Security+safety wrapper for NTFS disk access'],
 337                                                 'captive-install-acquire'=>[1,'Find MS Windows XP driver files for NTFS'],
 338 ###                                             'captive-install-fstab'=>[1,'Manage captive-ntfs /etc/fstab entries'],
 339                                                 );
 340                                 my @r;
 341                                 while (@mans) {
 342                                         my $file=shift @mans;
 343                                         my($section,$name)=@{shift @mans};
 344                                         push @r,"<li>".a_href("man/$file.pod.html",$file)."($section) - $name</li>\n";
 345                                         }
 346                                 @r;
 347                                 }
 348                         ]}
 349                 </ul></li>
 350         <li>@{[ a_href 'Resources.html.pl','Related Pages' ]}</li>
 351         <li>@{[ a_href 'Thanks.html.pl','Thanks' ]}</li>
 352 </ul>
 353
 354 @{[ vskip "3ex" ]}
 355
 356 <p class="stuff">
 357         Why did I install Microsoft Windows and wrote such disgusting piece of code?<br />
 358         Expecting @{[ a_href top_dir()."/CV.html.pl","yet another challenging task" ]}, !
 359 </p>
 360 HERE
 361
 362
 363 My::Web->footer();