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