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