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