48580e85fa8949c1aea6101d7ea1a57ec98eb26f
[www.jankratochvil.net.git] / project / captive / Index.pm
1 # $Id$
2 # Main page of 'My::Project::captive'
3 # Copyright (C) 2003-2005 Jan Kratochvil <project-www.jankratochvil.net@jankratochvil.net>
4
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; exactly version 2 of June 1991 is required
8
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 # GNU General Public License for more details.
13
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software
16 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
18
19 package project::captive::Index;
20 require 5.6.0;  # at least 'use warnings;' but we need some 5.6.0+ modules anyway
21 our $VERSION=do { my @r=(q$Revision$=~/\d+/g); sprintf "%d.".("%03d"x$#r),@r; };
22 our $CVS_ID=q$Id$;
23 use strict;
24 use warnings;
25
26 use My::Web;
27 Wuse 'project::Lib';
28
29
30 our @ListItem=(
31                 "name"=>"Captive",
32                 "platform"=>"unixuser",
33                 "priority"=>666,
34                 "summary"=>"The first free NTFS read/write filesystem for GNU/Linux",
35                 "license"=>"GPL",
36                 "maintenance"=>"active",
37                 "language"=>"i386 asm, C, Perl",
38                 "icon"=>"captive-install-acquire-icon.png",
39                 "cvs-of main tree"=>"captive",
40                 "cvs-of branched ReactOS subdir"=>"reactos:captive",
41                 "description"=>sub { return <<"HERE"; },
42 <p>Project implements the first full read/write free access to NTFS disk drives.
43 You can mount your Microsoft Windows NT, 200x or XP partition as
44 a transparently accessible volume for your GNU/Linux.</p>
45 <p>This compatibility was achieved in
46 the @{[ a_href 'http://www.winehq.com/','Wine' ]} way by using the original
47 Microsoft Windows <i>ntfs.sys</i> driver. It emulates the required subsystems of
48 the Microsoft Windows kernel by reusing one of the original
49 <i>ntoskrnl.exe</i>, @{[ a_href 'http://www.reactos.com/','ReactOS' ]} parts, or
50 this project's own reimplementations, on a case by case basis.
51 Project includes the first open source MS-Windows kernel API for Free operating systems.
52 Involvement of the original driver files was chosen to achieve the best
53 and unprecedented filesystem compatibility and safety.</p>
54 <p>As opposed to other projects this is currently the only software supporting the full
55 read/write access including the possibility to create/delete files, modify directories
56 etc.</p>
57 HERE
58                 );
59
60 sub handler
61 {
62 my $W=project::Lib->init(
63                 "no_project_data"=>1,
64                 "css_push"=>"./Index.css",
65                 "project_text_after_title"=>sub { return ""
66                                 .'<table border="0" class="navigate"><tr>'
67                                         .'<td>&bull;&nbsp;'.a_href('#download','Download').'</td>'
68                                         .'<td>&bull;&nbsp;'.a_href('#news','NEWS').'</td>'
69                                         .'<td>&bull;&nbsp;'.a_href('#testimonials','Testimonials').'</td>'
70                                         .'<td>&bull;&nbsp;'.a_href('#press','Internet Press').'</td>'
71                                         .'<td>&bull;&nbsp;'.a_href('#notes','Installation Notes').'</td>'
72                                         .'<td>&bull;&nbsp;'.a_href('#lists','Mailing Lists').'</td>'
73                                         .'<td>&bull;&nbsp;'.a_href('#seealso','See Also').'</td>'
74                                 .'</tr></table>'
75                                 },
76                 "project::Lib-init-hook"=>sub {
77                         if (my $file=$W->{"args"}{"file"}) {
78                                 My::Web::header("Refresh"=>"1;url=".path_web("./dist/$file","abs"=>1));
79                                 }
80                         },
81                 );
82
83
84 &{$_}() for reverse @{$W->{"footing_delimit_sub_push"}};
85
86 my $version="1.1.7";
87 my $revision="0";
88
89 Wrequire 'project::captive::DriverSurvey';
90 my $survey_want=1;
91 $survey_want=0; # Temporarily forced, enough data so far.
92 $survey_want=0 if $W->{"args"}{"file"};
93 $survey_want=0 if project::captive::DriverSurvey::cookie();
94
95 local *download=sub($)
96 {
97 my($name)=@_;
98
99         # Do not: ,"attr"=>'target="_blank"'
100         # as it would require Framed XHTML.
101         my $real="dist/$name";
102         return a_href './DriverSurvey.pm?file='.$name,$name,"size"=>$real
103                         if $survey_want;
104         return a_href $real,$name,"size"=>1;
105 };
106
107 print <<"HERE";
108 <h2 id="download">Download</h2>
109
110 <h3>Choose the one preferred installation format:</h3>
111
112 <table border="1" frame="border" rules="rows" style="text-align: center;" class="download">
113         <tr>
114                 <td>
115                         <p>RPM i386 binary<br />tested for distributions:</p>
116                         <table border="0"><tr><td align="left"><ul>
117                                 <li>Fedora&nbsp;Core&nbsp;4</li>
118                         </ul></td></tr></table>
119                 </td>
120                 <td>@{[ download("captive-static-$version-$revision.i386.rpm") ]}</td>
121         </tr>
122         <tr>
123                 <td>
124                         <p>.tar.gz i386 binary<br />(for non-RPM distributions)</p>
125                 </td>
126                 <td>@{[ download("captive-static-$version.tar.gz") ]}</td>
127         </tr>
128         <tr>
129                 <td>Source archives</td>
130                 <td>@{[ a_href 'CVS.pm#source','download link' ]}</td>
131         </tr>
132 </table>
133 HERE
134
135 if (!$survey_want) {
136         print <<"HERE";
137 <p>@{[ a_href 'DriverSurvey.pm','Linux Drivers Availability survey' ]} link
138 - if you already answered before.</p>
139 HERE
140         }
141
142 print <<"HERE";
143 @{[ vskip "3ex" ]}
144
145 <h2 id="news">NEWS</h2>
146
147 <dl>
148         <dt>captive-1.1.7 (2006-01-26) [@{[ a_href $W->{"project_viewcvs"}.'captive/NEWS?rev=HEAD','archive' ]}]</dt>
149         <dd>
150                 <ul>
151                         <li>Fixed sandbox restarting looking like disconnected mounts (FUSE client only)</li>
152                         <li>Workarounded no FUSE/Linux-kernel charset support - fixes locale filenames</li>
153                         <li>Fixed multiple issues of captive-install-acquire(1) to run at all again</li>
154                         <li>Fixed general operations refusal on invalid errnos</li>
155                         <li>Fixed invalid file timestamps (FUSE client only)</li>
156                         <li>Workarounded FUSE/Linux-kernel user mounts (FUSE only)</li>
157                         <li>Workarounded FUSE/Linux-kernel modprobe(8)ing (FUSE only)</li>
158                         <li>(static .tar.gz build only) Debian now a bit more compatible</li>
159                 </ul>
160         </dd>
161 </dl>
162
163 @{[ vskip "3ex" ]}
164
165 <h2 id="testimonials">Captive NTFS Testimonials</h2>
166
167 <ul>
168         <li>Hospital of Castelo Branco - Bruno Santos
169                 <p>we are preparing the machines to install another system that will allow
170                 the digitalization of medical images - PACS (picture archive and
171                 communication system).</p>
172
173                 <p>since the computers that are need are about 100 and we need to install
174                 windows in all of them (even we have an almost automated instalation - but
175                 requires some administrator interaction). So, we want to install
176                 windows2000 without pressing a key.</p>
177
178                 <p>@{[ a_href 'TestimonialBrunoSantos.pm','<span style="font-style: italic;">[ more ]</span>' ]}</p>
179         </li>
180         <li>@{[ a_href 'http://www.amunra.co.uk/','Dave &quot;AmunRa&quot; Rigby' ]}
181                 <p>Ok, I'm impressed (@{[ a_href 'http://www.amunra.co.uk/archives/000028.php','Captive Review' ]})</p>
182                 <p>Linux software generally has a reputation for having some great, novell
183                 ideas, but often lacking in the general 'spit and polish' - difficult to
184                 install, unreliable, and so on. However the latest program I have tried out
185                 - Captive, is a breath of fresh air - simple to install and set up, and It
186                 Just WorksTM. And not only that, it's probably one of the most useful and
187                 technically impressive projects I've seen in a long time ...</p>
188                 <p><span style="font-style: italic;">[ snip ]</span></p>
189         </li>
190         <li>Derek J Witt
191                 <p>I commend you for this project. I am currently using this on my XP NTFS
192                 partitions and I am impressed that I can actually move, edit, and remove files
193                 and directories with no apparent ill effects. This is very nice indeed.</p>
194                 <p>I initially was skeptical because it uses wine and parts of ReactOS
195                  (I have messed with this OS a few times), but you have proved me wrong. I have
196                 noticed no lag on my system.  I do notice the initial mounting process does
197                 take slightly longer than the Linux-NTFS project. But, once I'm past that, it's
198                 quite transparent.</p>
199                 <p><span style="font-style: italic;">[ technical question cut ]</span></p>
200         </li>
201         <li>James Van't Slot
202                 <p>Just wanted to drop you a note and say &quot;Excellent work!&quot;</p>
203                 <p>I just installed captive and it worked as advertized right out of the
204                 rpm.  Thanks, I've been holding off recompiling my kernel until NTFS is
205                 supported out of the box for Redhat.  Now I don't have to bother.</p>
206                 <p>Thanks again and keep up the great work.</p>
207         </li>
208 </ul>
209
210 <h2 id="press">@{[ a_href 'Press.pm','Internet Press' ]}</h2>
211
212 @{[ vskip "3ex" ]}
213
214
215 <h1 id="notes">Installation Notes</h1>
216 <p>You should first run <b>captive-install-acquire</b> command to check your
217 available Microsoft Windows drivers versions. Now you can execute:</p>
218
219 <blockquote>
220         <p class="quote">
221                 # mkdir /mnt/dosc<br />
222                 # mount -t captive-ntfs /dev/hda1 /mnt/dosc
223         </p>
224 </blockquote>
225
226
227 <h2>Overview</h2>
228
229 <p>Any errors from '<b>captive-fuse</b>' are written to '<b>/var/log/messages</b>'.</p>
230 <p>Needed drivers (at least ntoskrnl.exe+ntfs.sys) must be in '<b>/var/lib/captive</b>'.</p>
231 <p>'<b>captive</b>' package creates '<b>captive</b>' user and '<b>captive</b>' group on your system.</p>
232
233
234 <h2>FUSE Kernel Driver Module</h2>
235
236 <p>@{[ a_href 'http://fuse.sourceforge.net/','FUSE' ]} (Filesystem in Userspace)
237 needs Linux kernel module driver (<i>fuse.ko</i>) compatible with your
238 running Linux kernel.</p>
239
240 <p>If you cannot <b>mount</b>(8) your NTFS filesystem you should check your
241 Linux kernel is based on version at least 2.6.14 where
242 @{[ a_href 'http://fuse.sourceforge.net/','FUSE' ]} got imported. You should
243 also check the module is enabled or even built-in.</p>
244
245
246 HERE
247
248
249 print rightimg <<"HERE",'reactos.png','ReactOS',"a_href"=>'http://www.reactos.com/';
250         <h2>The First Open Source MS-Windows Kernel API for Free OS</h2>
251
252         <p>Compatibility with the existing binary Microsoft Windows file system drivers has been
253         reached. Microsoft Windows kernel system components required by these drivers
254         were analyzed and successfully emulated in the GNU/Linux operating system.
255         The project brings the Microsoft Windows kernel emulation framework to support even
256         other types of Microsoft Windows drivers in the future.
257         The <span class="productname">@{[ a_href 'http://www.reactos.com/','ReactOS' ]}</span>
258         code base proved to be a big asset for this functionality.</p>
259 HERE
260
261
262 my @lists=qw(captive-announce-list captive-list captive-devel-list);
263
264 print <<"HERE";
265
266 <h2 id="lists">Mailing Lists</h2>
267
268 <form action="@{[ uri_escaped(path_web "/Mailman.pm") ]}" @{[ form_method "post" ]}>
269         <table border="1" class="mailman" style="border-collapse: collapse; border-style: solid; border-width: 1px;">
270                 <tr>@{[ map('<th>'.$_.'@jankratochvil.net</th>',@lists) ]}</tr>
271                 <tr><td>New version announcements<br />
272                         (low traffic, recommended)</td>
273                                 <td>User support,<br />bug reports</td>
274                                 <td>Development</td>
275                                 </tr>
276                 <tr>@{[ map({ "<td>".a_href($W->{"mailman_url"}."listinfo/$_",'Mailman Infopage')."</td>"; } @lists) ]}</tr>
277                 <tr>@{[ map({ "<td>".a_href($W->{"pipermail_url"}."$_",'Archive')."</td>"; } @lists) ]}</tr>
278                 <tr>@{[
279                         map(('<td><input type="checkbox" name="list" value="'.$_.'"'
280                                         .($_ ne "captive-announce-list" ? '' : ' checked="checked"')
281                                         .' /> Subscribe?</td>'),@lists)
282                         ]}</tr>
283                 <tr><td colspan="3">
284                         <table border="0" style="text-align: left;">
285                                 <tr><td>Email address:            </td><td><input type="text"     name="email"   size="30" /></td></tr>
286                                 <tr><td>Your new Mailman password:</td><td><input type="password" name="pw"      size="15" /></td></tr>
287                                 <tr><td>Reenter your password:    </td><td><input type="password" name="pw-conf" size="15" /></td></tr>
288                         </table>
289                         <p>
290                                 <input type="hidden" name="back" value="/project/captive/#lists" />
291                                 <input type="submit" name="email-button" value="Subscribe me" />
292                         </p>
293                 </td></tr>
294         </table>
295 </form>
296
297
298 @{[ vskip "3ex" ]}
299
300 <h1 id="seealso">See Also</h1>
301 <ul>
302         <li>@{[ a_href 'Preview.pm','Technology Preview' ]}</li>
303         <li>@{[ a_href 'CVS.pm','Download Sources, CVS Repository' ]}</li>
304         <li>@{[ a_href 'doc/','Developer Documentation' ]}; highlights:<ul>
305                 <li>@{[ a_href 'doc/About.pm#versions','Microsoft Windows Versions Compatibility' ]}</li>
306                 <li>@{[ a_href 'doc/Architecture.pm#law','Laws and Licensing Conditions' ]}</li>
307                 <li>@{[ a_href 'doc/Details.pm#sandbox','Sandboxing of W32 Filesystem' ]}</li>
308                 <li>@{[ a_href 'doc/TODO.pm#todo_fsck','TODO: Fsck of NTFS' ]}</li>
309                 <li>@{[ a_href 'doc/Related.pm#LinuxNTFScompet','Related Projects - Linux NTFS' ]}</li>
310                 <li>@{[ a_href 'doc/Related.pm#vmware','Related Projects - VMware Workstation' ]}</li>
311                 <li>@{[ a_href 'doc/LinuxNTFS.pm',"Re: 7.7 Can't we write a wrapper for Windows' driver?" ]}</li>
312                 </ul></li>
313         <li>@{[ a_href $W->{"project_viewcvs"}.'/*checkout*/captive/TODO?rev=HEAD','Known Bugs' ]}</li>
314         <li>Man Pages<ul>
315                 @{[
316                         do {
317                                 my @mans=(
318                                                 'captive'=>[7,'Microsoft Windows NT kernel emulation for NTFS disk access'],
319                                                 'mount.captive'=>[8,'mount(8) interface for NTFS disk access'],
320                                                 'captive-cmdline'=>[1,'Command-line client for captive(7) NTFS disk access'],
321 ###                                             'captive-sandbox-server'=>[1,'Security+safety wrapper for NTFS disk access'],
322                                                 'captive-install-acquire'=>[1,'Find MS Windows XP driver files for NTFS'],
323 ###                                             'captive-install-fstab'=>[1,'Manage captive-ntfs /etc/fstab entries'],
324                                                 );
325                                 my @r;
326                                 while (@mans) {
327                                         my $file=shift @mans;
328                                         my($section,$name)=@{shift @mans};
329                                         push @r,"<li>".a_href("man/$file.pod.html",$file)."($section) - $name</li>\n";
330                                         }
331                                 @r;
332                                 }
333                         ]}
334                 </ul></li>
335         <li>@{[ a_href 'Resources.pm','Related Pages' ]}</li>
336         <li>@{[ a_href 'Thanks.pm','Thanks' ]}</li>
337 </ul>
338 HERE
339
340
341 exit;
342 }
343 1;