Cease the DriverSurvey link completely.
[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 my $survey_enable=0;    # Temporarily forced, enough data so far.
90
91 Wrequire 'project::captive::DriverSurvey';
92 my $survey_want=$survey_enable;
93 $survey_want=0 if $W->{"args"}{"file"};
94 $survey_want=0 if project::captive::DriverSurvey::cookie();
95
96 local *download=sub($)
97 {
98 my($name)=@_;
99
100         # Do not: ,"attr"=>'target="_blank"'
101         # as it would require Framed XHTML.
102         my $real="dist/$name";
103         return a_href './DriverSurvey.pm?file='.$name,$name,"size"=>$real
104                         if $survey_want;
105         return a_href $real,$name,"size"=>1;
106 };
107
108 print <<"HERE";
109 <h2 id="download">Download</h2>
110
111 <h3>Choose the one preferred installation format:</h3>
112
113 <table border="1" frame="border" rules="rows" style="text-align: center;" class="download">
114         <tr>
115                 <td>
116                         <p>RPM i386 binary<br />tested for distributions:</p>
117                         <table border="0"><tr><td align="left"><ul>
118                                 <li>Fedora&nbsp;Core&nbsp;4</li>
119                         </ul></td></tr></table>
120                 </td>
121                 <td>@{[ download("captive-static-$version-$revision.i386.rpm") ]}</td>
122         </tr>
123         <tr>
124                 <td>
125                         <p>.tar.gz i386 binary<br />(for non-RPM distributions)</p>
126                 </td>
127                 <td>@{[ download("captive-static-$version.tar.gz") ]}</td>
128         </tr>
129         <tr>
130                 <td>Source archives</td>
131                 <td>@{[ a_href 'CVS.pm#source','download link' ]}</td>
132         </tr>
133 </table>
134 HERE
135
136 if ($survey_enable && !$survey_want) {
137         print <<"HERE";
138 <p>@{[ a_href 'DriverSurvey.pm','Linux Drivers Availability survey' ]} link
139 - if you already answered before.</p>
140 HERE
141         }
142
143 print <<"HERE";
144 @{[ vskip "3ex" ]}
145
146 <h2 id="news">NEWS</h2>
147
148 <dl>
149         <dt>captive-1.1.7 (2006-01-26) [@{[ a_href $W->{"project_viewcvs"}.'captive/NEWS?rev=HEAD','archive' ]}]</dt>
150         <dd>
151                 <ul>
152                         <li>Fixed sandbox restarting looking like disconnected mounts (FUSE client only)</li>
153                         <li>Workarounded no FUSE/Linux-kernel charset support - fixes locale filenames</li>
154                         <li>Fixed multiple issues of captive-install-acquire(1) to run at all again</li>
155                         <li>Fixed general operations refusal on invalid errnos</li>
156                         <li>Fixed invalid file timestamps (FUSE client only)</li>
157                         <li>Workarounded FUSE/Linux-kernel user mounts (FUSE only)</li>
158                         <li>Workarounded FUSE/Linux-kernel modprobe(8)ing (FUSE only)</li>
159                         <li>(static .tar.gz build only) Debian now a bit more compatible</li>
160                 </ul>
161         </dd>
162 </dl>
163
164 @{[ vskip "3ex" ]}
165
166 <h2 id="testimonials">Captive NTFS Testimonials</h2>
167
168 <ul>
169         <li>Hospital of Castelo Branco - Bruno Santos
170                 <p>we are preparing the machines to install another system that will allow
171                 the digitalization of medical images - PACS (picture archive and
172                 communication system).</p>
173
174                 <p>since the computers that are need are about 100 and we need to install
175                 windows in all of them (even we have an almost automated instalation - but
176                 requires some administrator interaction). So, we want to install
177                 windows2000 without pressing a key.</p>
178
179                 <p>@{[ a_href 'TestimonialBrunoSantos.pm','<span style="font-style: italic;">[ more ]</span>' ]}</p>
180         </li>
181         <li>@{[ a_href 'http://www.amunra.co.uk/','Dave &quot;AmunRa&quot; Rigby' ]}
182                 <p>Ok, I'm impressed (@{[ a_href 'http://www.amunra.co.uk/archives/000028.php','Captive Review' ]})</p>
183                 <p>Linux software generally has a reputation for having some great, novell
184                 ideas, but often lacking in the general 'spit and polish' - difficult to
185                 install, unreliable, and so on. However the latest program I have tried out
186                 - Captive, is a breath of fresh air - simple to install and set up, and It
187                 Just WorksTM. And not only that, it's probably one of the most useful and
188                 technically impressive projects I've seen in a long time ...</p>
189                 <p><span style="font-style: italic;">[ snip ]</span></p>
190         </li>
191         <li>Derek J Witt
192                 <p>I commend you for this project. I am currently using this on my XP NTFS
193                 partitions and I am impressed that I can actually move, edit, and remove files
194                 and directories with no apparent ill effects. This is very nice indeed.</p>
195                 <p>I initially was skeptical because it uses wine and parts of ReactOS
196                  (I have messed with this OS a few times), but you have proved me wrong. I have
197                 noticed no lag on my system.  I do notice the initial mounting process does
198                 take slightly longer than the Linux-NTFS project. But, once I'm past that, it's
199                 quite transparent.</p>
200                 <p><span style="font-style: italic;">[ technical question cut ]</span></p>
201         </li>
202         <li>James Van't Slot
203                 <p>Just wanted to drop you a note and say &quot;Excellent work!&quot;</p>
204                 <p>I just installed captive and it worked as advertized right out of the
205                 rpm.  Thanks, I've been holding off recompiling my kernel until NTFS is
206                 supported out of the box for Redhat.  Now I don't have to bother.</p>
207                 <p>Thanks again and keep up the great work.</p>
208         </li>
209 </ul>
210
211 <h2 id="press">@{[ a_href 'Press.pm','Internet Press' ]}</h2>
212
213 @{[ vskip "3ex" ]}
214
215
216 <h1 id="notes">Installation Notes</h1>
217 <p>You should first run <b>captive-install-acquire</b> command to check your
218 available Microsoft Windows drivers versions. Now you can execute:</p>
219
220 <blockquote>
221         <p class="quote">
222                 # mkdir /mnt/dosc<br />
223                 # mount -t captive-ntfs /dev/hda1 /mnt/dosc
224         </p>
225 </blockquote>
226
227
228 <h2>Overview</h2>
229
230 <p>Any errors from '<b>captive-fuse</b>' are written to '<b>/var/log/messages</b>'.</p>
231 <p>Needed drivers (at least ntoskrnl.exe+ntfs.sys) must be in '<b>/var/lib/captive</b>'.</p>
232 <p>'<b>captive</b>' package creates '<b>captive</b>' user and '<b>captive</b>' group on your system.</p>
233
234
235 <h2>FUSE Kernel Driver Module</h2>
236
237 <p>@{[ a_href 'http://fuse.sourceforge.net/','FUSE' ]} (Filesystem in Userspace)
238 needs Linux kernel module driver (<i>fuse.ko</i>) compatible with your
239 running Linux kernel.</p>
240
241 <p>If you cannot <b>mount</b>(8) your NTFS filesystem you should check your
242 Linux kernel is based on version at least 2.6.14 where
243 @{[ a_href 'http://fuse.sourceforge.net/','FUSE' ]} got imported. You should
244 also check the module is enabled or even built-in.</p>
245
246
247 HERE
248
249
250 print rightimg <<"HERE",'reactos.png','ReactOS',"a_href"=>'http://www.reactos.com/';
251         <h2>The First Open Source MS-Windows Kernel API for Free OS</h2>
252
253         <p>Compatibility with the existing binary Microsoft Windows file system drivers has been
254         reached. Microsoft Windows kernel system components required by these drivers
255         were analyzed and successfully emulated in the GNU/Linux operating system.
256         The project brings the Microsoft Windows kernel emulation framework to support even
257         other types of Microsoft Windows drivers in the future.
258         The <span class="productname">@{[ a_href 'http://www.reactos.com/','ReactOS' ]}</span>
259         code base proved to be a big asset for this functionality.</p>
260 HERE
261
262
263 my @lists=qw(captive-announce-list captive-list captive-devel-list);
264
265 print <<"HERE";
266
267 <h2 id="lists">Mailing Lists</h2>
268
269 <form action="@{[ uri_escaped(path_web "/Mailman.pm") ]}" @{[ form_method "post" ]}>
270         <table border="1" class="mailman" style="border-collapse: collapse; border-style: solid; border-width: 1px;">
271                 <tr>@{[ map('<th>'.$_.'@jankratochvil.net</th>',@lists) ]}</tr>
272                 <tr><td>New version announcements<br />
273                         (low traffic, recommended)</td>
274                                 <td>User support,<br />bug reports</td>
275                                 <td>Development</td>
276                                 </tr>
277                 <tr>@{[ map({ "<td>".a_href($W->{"mailman_url"}."listinfo/$_",'Mailman Infopage')."</td>"; } @lists) ]}</tr>
278                 <tr>@{[ map({ "<td>".a_href($W->{"pipermail_url"}."$_",'Archive')."</td>"; } @lists) ]}</tr>
279                 <tr>@{[
280                         map(('<td><input type="checkbox" name="list" value="'.$_.'"'
281                                         .($_ ne "captive-announce-list" ? '' : ' checked="checked"')
282                                         .' /> Subscribe?</td>'),@lists)
283                         ]}</tr>
284                 <tr><td colspan="3">
285                         <table border="0" style="text-align: left;">
286                                 <tr><td>Email address:            </td><td><input type="text"     name="email"   size="30" /></td></tr>
287                                 <tr><td>Your new Mailman password:</td><td><input type="password" name="pw"      size="15" /></td></tr>
288                                 <tr><td>Reenter your password:    </td><td><input type="password" name="pw-conf" size="15" /></td></tr>
289                         </table>
290                         <p>
291                                 <input type="hidden" name="back" value="/project/captive/#lists" />
292                                 <input type="submit" name="email-button" value="Subscribe me" />
293                         </p>
294                 </td></tr>
295         </table>
296 </form>
297
298
299 @{[ vskip "3ex" ]}
300
301 <h1 id="seealso">See Also</h1>
302 <ul>
303         <li>@{[ a_href 'Preview.pm','Technology Preview' ]}</li>
304         <li>@{[ a_href 'CVS.pm','Download Sources, CVS Repository' ]}</li>
305         <li>@{[ a_href 'doc/','Developer Documentation' ]}; highlights:<ul>
306                 <li>@{[ a_href 'doc/About.pm#versions','Microsoft Windows Versions Compatibility' ]}</li>
307                 <li>@{[ a_href 'doc/Architecture.pm#law','Laws and Licensing Conditions' ]}</li>
308                 <li>@{[ a_href 'doc/Details.pm#sandbox','Sandboxing of W32 Filesystem' ]}</li>
309                 <li>@{[ a_href 'doc/TODO.pm#todo_fsck','TODO: Fsck of NTFS' ]}</li>
310                 <li>@{[ a_href 'doc/Related.pm#LinuxNTFScompet','Related Projects - Linux NTFS' ]}</li>
311                 <li>@{[ a_href 'doc/Related.pm#vmware','Related Projects - VMware Workstation' ]}</li>
312                 <li>@{[ a_href 'doc/LinuxNTFS.pm',"Re: 7.7 Can't we write a wrapper for Windows' driver?" ]}</li>
313                 </ul></li>
314         <li>@{[ a_href $W->{"project_viewcvs"}.'/*checkout*/captive/TODO?rev=HEAD','Known Bugs' ]}</li>
315         <li>Man Pages<ul>
316                 @{[
317                         do {
318                                 my @mans=(
319                                                 'captive'=>[7,'Microsoft Windows NT kernel emulation for NTFS disk access'],
320                                                 'mount.captive'=>[8,'mount(8) interface for NTFS disk access'],
321                                                 'captive-cmdline'=>[1,'Command-line client for captive(7) NTFS disk access'],
322 ###                                             'captive-sandbox-server'=>[1,'Security+safety wrapper for NTFS disk access'],
323                                                 'captive-install-acquire'=>[1,'Find MS Windows XP driver files for NTFS'],
324 ###                                             'captive-install-fstab'=>[1,'Manage captive-ntfs /etc/fstab entries'],
325                                                 );
326                                 my @r;
327                                 while (@mans) {
328                                         my $file=shift @mans;
329                                         my($section,$name)=@{shift @mans};
330                                         push @r,"<li>".a_href("man/$file.pod.html",$file)."($section) - $name</li>\n";
331                                         }
332                                 @r;
333                                 }
334                         ]}
335                 </ul></li>
336         <li>@{[ a_href 'Resources.pm','Related Pages' ]}</li>
337         <li>@{[ a_href 'Thanks.pm','Thanks' ]}</li>
338 </ul>
339 HERE
340
341
342 exit;
343 }
344 1;