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