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