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