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 <table border="0" width="100%"><tr><td align="center">
  72         <table border="0" style="margin: 4ex; padding: 2ex; background: #552222;">
  73                 <tr><td style="font-size: larger;">
  74                         Why did I install Microsoft Windows and write such a disgusting piece of code?<br />
  75                         Expecting @{[ a_href $W->{"resume_url"},"yet another challenging task" ]}!
  76                 </td></tr>
  77         </table>
  78 </table>
  79
  80 @{[ vskip "3ex" ]}
  81
  82
  83 <table border="1" align="center" style="text-align: center;" width="100%"><tr><th>Distribution</th>
  84                 <th>Installation Case #1<br />Filesystem and installer<br />(recommended)</th>
  85                 <th>Installation Case #2<br />Manual installation<br />(filesystem, expert user)</th>
  86                 <th>Installation Case #3<br />Command-line client<br />(no filesystem access)</th></tr>
  87 HERE
  88 my %pkg=(
  89                 1=>[qw(captive captive-lufs captive-install lufs gnome-vfs-httpcaptive ntfsprogs ntfsprogs-gnomevfs)],
  90                 2=>[qw(captive captive-lufs                 lufs)],
  91                 3=>[qw(captive)],
  92                 );
  93 my %reqpkg=(
  94                 1 =>[qw(glib2 gnome-vfs2 ORBit2 libxml2 openssl popt readline libgnomeui)],
  95                 23=>[qw(glib2 gnome-vfs2 ORBit2 libxml2 openssl popt readline)],
  96                 );
  97 my %version=(
  98                 map(($_=>["1.0","0"]),qw(captive captive-lufs captive-install)),
  99                 "lufs"=>["0.9.6","1captive6"],
 100                 "gnome-vfs-httpcaptive"=>["2.3.8captive2","0"],
 101                 "ntfsprogs"=>["200309071734","1captive1"],
 102                 "ntfsprogs-gnomevfs"=>["1.0.2","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 @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);
 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<br />"
 150                                         ."(".a_href("#libxml2_rh8","libxml2 upgrade note").")",
 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 (@libxml2_rh8_pkgs) {
 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 "<tr style=\"height: 2ex;\"></tr>\n";
 224 print "<tr>";
 225         print "<td>Package Requirements</td>";
 226         for my $case (1,23) {
 227                 print "<td".($case==23 ? ' colspan="2"' : '').">";
 228                 print join(", ",map("<span class=\"reqpkg\">$_</span>",@{$reqpkg{$case}}));
 229                 print "</td>";
 230                 }
 231 print "</tr>\n";
 232 print <<"HERE";
 233 </table>
 234
 235 <blockquote>
 236         <p><a name="libxml2_rh8"><b><i>Red Hat 8 Psyche</i> upgrade of <i>libxml2</i> package:</b></a>
 237         Upgrade only the packages already installed on your system to prevent
 238         many dependency requirements - do not use &quot;<code>rpm -U</code>&quot;,
 239         use &quot;<code>rpm -F</code>&quot; instead:</p>
 240         <blockquote><p class="quote">
 241                 <code>rpm -F @{[ join(" ",@libxml2_rh8_pkgs) ]}</code>
 242         </p></blockquote>
 243 </blockquote>
 244
 245 @{[ vskip "3ex" ]}
 246
 247
 248 <h1>Installation Notes</h1>
 249
 250 <p>You should first run <b>captive-install-acquire</b> command to check your
 251 available Microsoft Windows drivers versions. Now you can execute:</p>
 252
 253 <blockquote>
 254         <p class="quote">
 255                 # mkdir /mnt/dosc<br />
 256                 # mount -t captive-ntfs /dev/hda1 /mnt/dosc
 257         </p>
 258 </blockquote>
 259
 260
 261 <h2>Overview</h2>
 262
 263 <p>'<b>captive</b>' is the base package. It contains debugging '<b>captive-cmdline</b>' client.<br />
 264 '<b>captive-lufs</b>' permits mounting NTFS as regular filesystem. It needs '<b>lufs</b>'.<br />
 265 '<b>lufs</b>' is a daemon to enable userland process to provide filesystem functions.</p>
 266
 267 <p>Any errors from '<b>captive-lufs</b>' are written to '<b>/var/log/messages</b>'.</p>
 268
 269 <p>Needed drivers (at least ntoskrnl.exe+ntfs.sys) must be in '<b>/var/lib/captive</b>'.</p>
 270
 271 <p>'<b>captive</b>' package creates '<b>captive</b>' user and '<b>captive</b>' group on your system.</p>
 272
 273
 274 <h2>Package Version Conflicts</h2>
 275
 276 <dl>
 277
 278 <dt>@{[ a_href 'http://lufs.sourceforge.net/lufs/','lufs' ]}</dt>
 279 <dd><p><b>'captive' version required</b>: Although you may already have the
 280 original package installed you must replace it by the local 'captive'-marked
 281 version containing some 'captive'-essential fixes and extensions.</p></dd>
 282
 283 <dt>@{[ a_href 'http://linux-ntfs.sourceforge.net/','ntfsprogs' ]}</dt>
 284 <dd><p><b>Original version >=200309071734 sufficient</b>:
 285 The package which is downloadable from here, has no code patches - you can freely use the
 286 original version instead. Unfortunately, the last public release is
 287 <b>1.7.1</b> while this project requires at least
 288 @{[ a_href 'http://linux-ntfs.sourceforge.net/snapshots/','snapshot' ]} version
 289 <b>@{[ a_href 'http://linux-ntfs.sourceforge.net/snapshots/ntfsprogs-200309071734.tar.bz2','200309071734' ]}</b>
 290 which is not packaged (.rpm/.deb) yet. Packaged versions are provided here for
 291 your convenience.</p></dd>
 292
 293 </dl>
 294
 295
 296 <h2>LUFS Kernel Driver Module</h2>
 297
 298 <p>@{[ a_href 'http://lufs.sourceforge.net/lufs/','LUFS' ]} (Linux Userland File
 299 System) needs Linux kernel module driver (<i>lufs.o</i>) compatible with your
 300 running Linux kernel. The binary driver is supplied already precompiled for many
 301 Linux kernel versions in the binary packages above (<b>.i386.rpm</b> and
 302 <b>_i386.deb</b> archives).</p>
 303
 304 <p>If you cannot <b>mount</b>(8) your NTFS filesystem you should run <span
 305 class="quote">/usr/share/lufs/prepmod</span> to see the reasons. It is always
 306 recommended to upgrade to the latest stable kernel supplied by your GNU/Linux
 307 distribution vendor. You may need to install package
 308 <b>kernel-source</b> (Red Hat) or <b>kernel-headers</b> (Debian) matching your
 309 Linux kernel version (<b>rpm&nbsp;-q&nbsp;kernel</b>) and re-run <span
 310 class="quote">/usr/share/lufs/prepmod</span>.</p>
 311
 312 <p><b>WARNING:</b> This 'captive' package may modify your Linux kernel
 313 sources matching your currently running kernel version. These minor
 314 modifications may include a dependencies rebuild, compiling build tools, fixes of
 315 several include files, etc. All the modifications are done at the mount(8) time
 316 by the automatically executed <span class="quote">/usr/share/lufs/prepmod</span> script.
 317 This behavior was not present in the original
 318 @{[ a_href 'http://lufs.sourceforge.net/lufs/','LUFS' ]} distribution
 319 by @{[ a_href 'http://www.malinux.net/main/','Florin Malita' ]}.</p>
 320
 321
 322 HERE
 323
 324
 325 print rightimg <<"HERE",'reactos','ReactOS',"a_href"=>'http://www.reactos.com/';
 326         <h2>The First Open Source MS-Windows Kernel API for Free OS</h2>
 327
 328         <p>Compatibility with the existing binary Microsoft Windows file system drivers has been
 329         reached. Microsoft Windows kernel system components required by these drivers
 330         were analyzed and successfully emulated in the GNU/Linux operating system.
 331         The project brings the Microsoft Windows kernel emulation framework to support even
 332         other types of Microsoft Windows drivers in the future.
 333         The <span class="productname">@{[ a_href 'http://www.reactos.com/','ReactOS' ]}</span>
 334         code base proved to be a big asset for this functionality.</p>
 335 HERE
 336
 337
 338 my @lists=qw(captive-announce-list captive-list captive-devel-list);
 339
 340 print <<"HERE";
 341
 342 <a name="lists"><h2>Mailing Lists</h2></a>
 343
 344 <form action="@{[ top_dir("/Mailman.pl") ]}" method="post">
 345         <table border="1" class="mailman" style="border-collapse: collapse; border-style: solid; border-width: 1px;">
 346                 <tr>@{[ map('<th>'.$_.'@jankratochvil.net</th>',@lists) ]}</tr>
 347                 <tr><td>New version announcements<br />
 348                         (low traffic, recommended)</td>
 349                                 <td>User support,<br />bug reports</td>
 350                                 <td>Development</td>
 351                                 </tr>
 352                 <tr>@{[ map({ "<td>".a_href(&{$W->{"mailman_url_sub"}}()."/listinfo/$_",'Mailman Infopage')."</td>"; } @lists) ]}</tr>
 353                 <tr>@{[ map({ "<td>".a_href(&{$W->{"pipermail_url_sub"}}()."/$_",'Archive')."</td>"; } @lists) ]}</tr>
 354                 <tr>@{[
 355                         map(('<td><input type="checkbox" name="list" value="'.$_.'"'
 356                                         .($_ ne "captive-announce-list" ? '' : ' checked="checked"')
 357                                         .' /> Subscribe?</td>'),@lists)
 358                         ]}</tr>
 359                 <tr><td colspan="3">
 360                         <table border="0" style="text-align: left;">
 361                                 <tr><td>Email address:            </td><td><input type="text"     name="email"   size="30" /></td></tr>
 362                                 <tr><td>Your new Mailman password:</td><td><input type="password" name="pw"      size="15" /></td></tr>
 363                                 <tr><td>Reenter your password:    </td><td><input type="password" name="pw-conf" size="15" /></td></tr>
 364                         </table>
 365                         <p><input type="submit" name="email-button" value="Subscribe me" /></p>
 366                 </td></tr>
 367         </table>
 368 <input type="hidden" name="back" value="/project/captive/#lists" />
 369 </form>
 370
 371
 372 @{[ vskip "3ex" ]}
 373
 374 <h1>See Also</h1>
 375 <ul>
 376         <li>@{[ a_href 'Preview.html.pl','<span style="font-size: larger;">Technology Preview</span>' ]}</li>
 377         <li>@{[ a_href 'CVS.html.pl','CVS Repository' ]}</li>
 378         <li>@{[ a_href 'doc/','Developer Documentation' ]}; highlights:<ul>
 379                 <li>@{[ a_href 'doc/About.html.pl#versions','Microsoft Windows Versions Compatibility' ]}</li>
 380                 <li>@{[ a_href 'doc/Architecture.html.pl#law','Laws and Licensing Conditions' ]}</li>
 381                 <li>@{[ a_href 'doc/Details.html.pl#sandbox','Sandboxing of W32 Filesystem' ]}</li>
 382                 <li>@{[ a_href 'doc/TODO.html.pl#todo_fsck','TODO: Fsck of NTFS' ]}</li>
 383                 <li>@{[ a_href 'doc/TODO.html.pl#todo_surprise','TODO: NTFS Support for Partition Surprise' ]}</li>
 384                 <li>@{[ a_href 'doc/Related.html.pl#LinuxNTFScompet','Related Projects - Linux NTFS' ]}</li>
 385                 <li>@{[ a_href 'doc/Related.html.pl#vmware','Related Projects - VMware Workstation' ]}</li>
 386                 <li>@{[ a_href 'doc/LinuxNTFS.html.pl',"Re: 7.7 Can't we write a wrapper for Windows' driver?" ]}</li>
 387                 </ul></li>
 388         <li>@{[ a_href 'http://cvs.jankratochvil.net/viewcvs/*checkout*/captive/TODO?rev=HEAD','Known Bugs' ]}</li>
 389         <li>Man Pages<ul>
 390                 @{[
 391                         do {
 392                                 my @mans=(
 393                                                 'captive'=>[7,'Microsoft Windows NT kernel emulation for NTFS disk access'],
 394                                                 'mount.captive'=>[8,'mount(8) interface for NTFS disk access'],
 395                                                 'lufs-captivefs'=>[7,'Linux Userland File System module for NTFS as filesystem'],
 396                                                 'captive-cmdline'=>[1,'Command-line client for captive(7) NTFS disk access'],
 397 ###                                             'captive-sandbox-server'=>[1,'Security+safety wrapper for NTFS disk access'],
 398                                                 'captive-install-acquire'=>[1,'Find MS Windows XP driver files for NTFS'],
 399 ###                                             'captive-install-fstab'=>[1,'Manage captive-ntfs /etc/fstab entries'],
 400                                                 );
 401                                 my @r;
 402                                 while (@mans) {
 403                                         my $file=shift @mans;
 404                                         my($section,$name)=@{shift @mans};
 405                                         push @r,"<li>".a_href("man/$file.pod.html",$file)."($section) - $name</li>\n";
 406                                         }
 407                                 @r;
 408                                 }
 409                         ]}
 410                 </ul></li>
 411         <li>@{[ a_href 'Resources.html.pl','Related Pages' ]}</li>
 412         <li>@{[ a_href 'Thanks.html.pl','Thanks' ]}</li>
 413 </ul>
 414 HERE
 415
 416
 417 My::Web->footer();