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