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