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