&My::Web::footer call is deprecated now, use just: exit;
[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"=>"update",
37                 "language"=>"i386 asm, C, Perl",
38                 "icon"=>"captive-install-acquire-icon",
39                 "cvs-of main tree"=>"captive",
40                 "cvs-of branched ReactOS subdir"=>"reactos:captive",
41                 "cvs-of branched LUFS"=>"lufs:captive",
42                 "cvs-of 'httpcaptive://' method"=>"gnome-vfs-httpcaptive:captive",
43                 "cvs-of 'libntfs://' method"=>"ntfsprogs-gnomevfs",
44                 "description"=>sub { return <<"HERE"; },
45 <p>Project implements the first full read/write free access to NTFS disk drives.
46 You can mount your Microsoft Windows NT, 200x or XP partition as
47 a transparently accessible volume for your GNU/Linux.</p>
48 <p>This compatibility was achieved in
49 the @{[ a_href 'http://www.winehq.com/','Wine' ]} way by using the original
50 Microsoft Windows <i>ntfs.sys</i> driver. It emulates the required subsystems of
51 the Microsoft Windows kernel by reusing one of the original
52 <i>ntoskrnl.exe</i>, @{[ a_href 'http://www.reactos.com/','ReactOS' ]} parts, or
53 this project's own reimplementations, on a case by case basis.
54 Project includes the first open source MS-Windows kernel API for Free operating systems.
55 Involvement of the original driver files was chosen to achieve the best
56 and unprecedented filesystem compatibility and safety.</p>
57 <p>As opposed to other projects this is currently the only software supporting the full
58 read/write access including the possibility to create/delete files, modify directories
59 etc.</p>
60 HERE
61                 );
62
63 sub handler
64 {
65 my $W=project::Lib->init(
66                 "no_project_data"=>1,
67                 "css_push"=>"./Index.css",
68                 "project_text_after_title"=>sub { return ""
69                                 .'<table border="0" class="navigate"><tr>'
70                                         .'<td>&bull;&nbsp;'.a_href('#download','Download').'</td>'
71                                         .'<td>&bull;&nbsp;'.a_href('#news','NEWS').'</td>'
72                                         .'<td>&bull;&nbsp;'.a_href('#testimonials','Testimonials').'</td>'
73                                         .'<td>&bull;&nbsp;'.a_href('#press','Internet Press').'</td>'
74                                         .'<td>&bull;&nbsp;'.a_href('#notes','Installation Notes').'</td>'
75                                         .'<td>&bull;&nbsp;'.a_href('#lists','Mailing Lists').'</td>'
76                                         .'<td>&bull;&nbsp;'.a_href('#seealso','See Also').'</td>'
77                                 .'</tr></table>'
78                                 },
79                 );
80
81
82 print <<"HERE" if !$W->{"no_job"};
83 @{[ vskip "3ex" ]}
84
85 <table border="0" style="margin: 3ex; padding: 2ex; background: #bb8888;" class="margin-center">
86         <tr><td style="font-size: larger;">
87                 Looking for a challenging job: @{[ a_href $W->{"resume_url"},"My resume" ]}
88         </td></tr>
89 </table>
90 HERE
91
92 my %version=(
93                 map(($_=>["1.1.5","0"]),qw(captive captive-lufs captive-install)),
94                 "lufs"=>["0.9.7","1captive8"],
95                 );
96
97 print <<"HERE";
98 <h2 id="download">Download</h2>
99
100 <h3>Choose the one preferred installation format:</h3>
101
102 <table border="1" frame="border" rules="rows" style="text-align: center;" class="download">
103         <tr>
104                 <td>
105                         <p>RPM i386 binary<br />tested for distributions:</p>
106                         <table border="0"><tr><td align="left"><ul>
107                                 <li>Red&nbsp;Hat&nbsp;9&nbsp;Shrike</li>
108                                 <li>Red&nbsp;Hat&nbsp;8&nbsp;Psyche</li>
109                                 <li>SuSE&nbsp;9.0</li>
110                                 <li>SuSE&nbsp;9.1</li>
111                                 <li>Mandrake&nbsp;9.1&nbsp;Bamboo</li>
112                         </ul></td></tr></table>
113                 </td>
114                 <td>@{[ a_href 'dist/captive-static-'.$version{"captive"}[0].'-'.$version{"captive"}[1].'.i386.rpm',
115                                 undef(),"size"=>1,"basename"=>1 ]}</td>
116         </tr>
117         <tr>
118                 <td>
119                         <p>.tar.gz i386 binary<br />(for non-RPM distributions)</p>
120                 </td>
121                 <td>@{[ a_href 'dist/captive-static-'.$version{"captive"}[0].'.tar.gz',undef(),"size"=>1,"basename"=>1 ]}</td>
122         </tr>
123         <tr>
124                 <td>Source archives</td>
125                 <td>@{[ a_href 'CVS.pm#source','download link' ]}</td>
126         </tr>
127 </table>
128
129 <h4>Development Status</h4>
130
131 <p>Project is no longer developed. The key functionality is reached
132 by the latest released version. All its resources are available
133 @{[ a_href 'CVS.pm#source','here' ]} for download.</p>
134
135 <h4>Known Issue</h4>
136
137 <p>Captive was written to interface with the Linux kernel via
138 @{[ a_href 'http://lufs.sourceforge.net/lufs/','LUFS' ]}.
139 Unfortunately, this project is no longer being maintained by its author.
140 Mounting of NTFS devices usually works, but is no longer supported by the
141 author of Captive. Always unmount the device by umount(8) command before shutting
142 down your GNU/Linux system.</p>
143
144 <p>A port of Captive to the newer
145 @{[ a_href 'http://fuse.sourceforge.net/','FUSE' ]}
146 interface has not yet been implemented.
147 There is an experimental LUFS-FUSE bridge called
148 @{[ a_href 'http://sourceforge.net/project/showfiles.php?group_id=121684','lufis' ]}
149 that can be used in the meanwhile.
150 Also, the captive-cmdline(1) interface will get around any kernel compatibility
151 problems.</p>
152
153 @{[ vskip "3ex" ]}
154
155 <h2 id="news">NEWS</h2>
156
157 <dl>
158         <dt>captive-1.1.5 (2004-01-18) [@{[ a_href $W->{"project_viewcvs"}.'/*checkout*/captive/NEWS?rev=HEAD','archive' ]}]</dt>
159         <dd>
160                 <ul>
161                         <li>Fixed ignorance of the file truncate operation via LUFS (Matthias R.)</li>
162                         <li>Support for reading of HIDDEN SYSTEM NTFS files via LUFS</li>
163                         <li>Fixed refusal to mount some NT4.0 NTFSes (Nerijus Baliunas, Scott Chevalley)</li>
164                         <li>Support <code>/dev/ataraid</code> devices (Ivan Tonov)</li>
165                 </ul>
166         </dd>
167         <dt>lufs-0.9.7captive8 (2003-12-06) [@{[ a_href $W->{"project_viewcvs"}.'/*checkout*/lufs/NEWS.captive?rev=1.1.2.11','archive' ]}]</dt>
168 </dl>
169
170 @{[ vskip "3ex" ]}
171
172 <h2 id="testimonials">Captive NTFS Testimonials</h2>
173
174 <ul>
175         <li>Hospital of Castelo Branco - Bruno Santos
176                 <p>we are preparing the machines to install another system that will allow
177                 the digitalization of medical images - PACS (picture archive and
178                 communication system).</p>
179
180                 <p>since the computers that are need are about 100 and we need to install
181                 windows in all of them (even we have an almost automated instalation - but
182                 requires some administrator interaction). So, we want to install
183                 windows2000 without pressing a key.</p>
184
185                 <p>@{[ a_href 'TestimonialBrunoSantos.pm','<span style="font-style: italic;">[ more ]</span>' ]}</p>
186         </li>
187         <li>@{[ a_href 'http://www.amunra.co.uk/','Dave &quot;AmunRa&quot; Rigby' ]}
188                 <p>Ok, I'm impressed (@{[ a_href 'http://www.amunra.co.uk/archives/000028.php','Captive Review' ]})</p>
189                 <p>Linux software generally has a reputation for having some great, novell
190                 ideas, but often lacking in the general 'spit and polish' - difficult to
191                 install, unreliable, and so on. However the latest program I have tried out
192                 - Captive, is a breath of fresh air - simple to install and set up, and It
193                 Just WorksTM. And not only that, it's probably one of the most useful and
194                 technically impressive projects I've seen in a long time ...</p>
195                 <p><span style="font-style: italic;">[ snip ]</span></p>
196         </li>
197         <li>Derek J Witt
198                 <p>I commend you for this project. I am currently using this on my XP NTFS
199                 partitions and I am impressed that I can actually move, edit, and remove files
200                 and directories with no apparent ill effects. This is very nice indeed.</p>
201                 <p>I initially was skeptical because it uses wine and parts of ReactOS
202                  (I have messed with this OS a few times), but you have proved me wrong. I have
203                 noticed no lag on my system.  I do notice the initial mounting process does
204                 take slightly longer than the Linux-NTFS project. But, once I'm past that, it's
205                 quite transparent.</p>
206                 <p><span style="font-style: italic;">[ technical question cut ]</span></p>
207         </li>
208         <li>James Van't Slot
209                 <p>Just wanted to drop you a note and say &quot;Excellent work!&quot;</p>
210                 <p>I just installed captive and it worked as advertized right out of the
211                 rpm.  Thanks, I've been holding off recompiling my kernel until NTFS is
212                 supported out of the box for Redhat.  Now I don't have to bother.</p>
213                 <p>Thanks again and keep up the great work.</p>
214         </li>
215 </ul>
216
217 <h2 id="press">@{[ a_href 'Press.pm','Internet Press' ]}</h2>
218
219 @{[ vskip "3ex" ]}
220
221
222 <h1 id="notes">Installation Notes</h1>
223 <p>You should first run <b>captive-install-acquire</b> command to check your
224 available Microsoft Windows drivers versions. Now you can execute:</p>
225
226 <blockquote>
227         <p class="quote" style="white-space: pre;"
228 ># captive-cmdline \\
229                 --load-module=/var/lib/captive/ntoskrnl.exe \\
230                 --filesystem=/var/lib/captive/ntfs.sys \\
231                 --sandbox-server=/usr/sbin/captive-sandbox-server \\
232                 --bug-pathname=/tmp/captive-bug-%FT%T.captivebug.xml.gz \\
233                 --disk --rw /dev/hda1
234 # Now you can use ftp(1)-like command-line interface for the NTFS disk access.</p
235         >
236         <p>(Backslash end-of-line characters '\\' to be omitted for line continuation.)</p>
237 </blockquote>
238
239
240 <h2>Overview</h2>
241
242 <p>Any errors from '<b>captive-lufs</b>' are written to '<b>/var/log/messages</b>'.</p>
243 <p>Needed drivers (at least ntoskrnl.exe+ntfs.sys) must be in '<b>/var/lib/captive</b>'.</p>
244 <p>'<b>captive</b>' package creates '<b>captive</b>' user and '<b>captive</b>' group on your system.</p>
245
246
247 <h2>LUFS Kernel Driver Module</h2>
248
249 <p>@{[ a_href 'http://lufs.sourceforge.net/lufs/','LUFS' ]} (Linux Userland File
250 System) needs Linux kernel module driver (<i>lufs.o</i>) compatible with your
251 running Linux kernel. The binary driver is supplied already precompiled for many
252 Linux kernel versions in the binary packages above (<b>.i386.rpm</b> and
253 <b>_i386.deb</b> archives).</p>
254
255 <p>If you cannot <b>mount</b>(8) your NTFS filesystem you should run <span
256 class="quote">/usr/share/lufs/prepmod</span> to see the reasons. It is always
257 recommended to upgrade to the latest stable kernel supplied by your GNU/Linux
258 distribution vendor. You may need to install package
259 <b>kernel-source</b> (Red Hat) or <b>kernel-headers</b> (Debian) matching your
260 Linux kernel version (<b>rpm&nbsp;-q&nbsp;kernel</b>) and re-run <span
261 class="quote">/usr/share/lufs/prepmod</span>.</p>
262
263 <p><b>WARNING:</b> This 'captive' package may modify your Linux kernel
264 sources matching your currently running kernel version. These minor
265 modifications may include a dependencies rebuild, compiling build tools, fixes of
266 several include files, etc. All the modifications are done at the mount(8) time
267 by the automatically executed <span class="quote">/usr/share/lufs/prepmod</span> script.
268 This behavior was not present in the original
269 @{[ a_href 'http://lufs.sourceforge.net/lufs/','LUFS' ]} distribution
270 by @{[ a_href 'http://www.malinux.net/main/','Florin Malita' ]}.</p>
271
272
273 HERE
274
275
276 print rightimg <<"HERE",'reactos','ReactOS',"a_href"=>'http://www.reactos.com/';
277         <h2>The First Open Source MS-Windows Kernel API for Free OS</h2>
278
279         <p>Compatibility with the existing binary Microsoft Windows file system drivers has been
280         reached. Microsoft Windows kernel system components required by these drivers
281         were analyzed and successfully emulated in the GNU/Linux operating system.
282         The project brings the Microsoft Windows kernel emulation framework to support even
283         other types of Microsoft Windows drivers in the future.
284         The <span class="productname">@{[ a_href 'http://www.reactos.com/','ReactOS' ]}</span>
285         code base proved to be a big asset for this functionality.</p>
286 HERE
287
288
289 my @lists=qw(captive-announce-list captive-list captive-devel-list);
290
291 print <<"HERE";
292
293 <h2 id="lists">Mailing Lists</h2>
294
295 <form action="@{[ uri_escaped(path_web "/Mailman.pm") ]}" method="post">
296         <table border="1" class="mailman" style="border-collapse: collapse; border-style: solid; border-width: 1px;">
297                 <tr>@{[ map('<th>'.$_.'@jankratochvil.net</th>',@lists) ]}</tr>
298                 <tr><td>New version announcements<br />
299                         (low traffic, recommended)</td>
300                                 <td>User support,<br />bug reports</td>
301                                 <td>Development</td>
302                                 </tr>
303                 <tr>@{[ map({ "<td>".a_href($W->{"mailman_url"}."listinfo/$_",'Mailman Infopage')."</td>"; } @lists) ]}</tr>
304                 <tr>@{[ map({ "<td>".a_href($W->{"pipermail_url"}."$_",'Archive')."</td>"; } @lists) ]}</tr>
305                 <tr>@{[
306                         map(('<td><input type="checkbox" name="list" value="'.$_.'"'
307                                         .($_ ne "captive-announce-list" ? '' : ' checked="checked"')
308                                         .' /> Subscribe?</td>'),@lists)
309                         ]}</tr>
310                 <tr><td colspan="3">
311                         <table border="0" style="text-align: left;">
312                                 <tr><td>Email address:            </td><td><input type="text"     name="email"   size="30" /></td></tr>
313                                 <tr><td>Your new Mailman password:</td><td><input type="password" name="pw"      size="15" /></td></tr>
314                                 <tr><td>Reenter your password:    </td><td><input type="password" name="pw-conf" size="15" /></td></tr>
315                         </table>
316                         <p>
317                                 <input type="hidden" name="back" value="/project/captive/#lists" />
318                                 <input type="submit" name="email-button" value="Subscribe me" />
319                         </p>
320                 </td></tr>
321         </table>
322 </form>
323
324
325 @{[ vskip "3ex" ]}
326
327 <h1 id="seealso">See Also</h1>
328 <ul>
329         <li>@{[ a_href 'Preview.pm','Technology Preview' ]}</li>
330         <li>@{[ a_href 'CVS.pm','Download Sources, CVS Repository' ]}</li>
331         <li>@{[ a_href 'doc/','Developer Documentation' ]}; highlights:<ul>
332                 <li>@{[ a_href 'doc/About.pm#versions','Microsoft Windows Versions Compatibility' ]}</li>
333                 <li>@{[ a_href 'doc/Architecture.pm#law','Laws and Licensing Conditions' ]}</li>
334                 <li>@{[ a_href 'doc/Details.pm#sandbox','Sandboxing of W32 Filesystem' ]}</li>
335                 <li>@{[ a_href 'doc/TODO.pm#todo_fsck','TODO: Fsck of NTFS' ]}</li>
336                 <li>@{[ a_href 'doc/TODO.pm#todo_surprise','TODO: NTFS Support for Partition Surprise' ]}</li>
337                 <li>@{[ a_href 'doc/Related.pm#LinuxNTFScompet','Related Projects - Linux NTFS' ]}</li>
338                 <li>@{[ a_href 'doc/Related.pm#vmware','Related Projects - VMware Workstation' ]}</li>
339                 <li>@{[ a_href 'doc/LinuxNTFS.pm',"Re: 7.7 Can't we write a wrapper for Windows' driver?" ]}</li>
340                 </ul></li>
341         <li>@{[ a_href $W->{"project_viewcvs"}.'/*checkout*/captive/TODO?rev=HEAD','Known Bugs' ]}</li>
342         <li>Man Pages<ul>
343                 @{[
344                         do {
345                                 my @mans=(
346                                                 'captive'=>[7,'Microsoft Windows NT kernel emulation for NTFS disk access'],
347                                                 'mount.captive'=>[8,'mount(8) interface for NTFS disk access'],
348                                                 'lufs-captivefs'=>[7,'Linux Userland File System module for NTFS as filesystem'],
349                                                 'captive-cmdline'=>[1,'Command-line client for captive(7) NTFS disk access'],
350 ###                                             'captive-sandbox-server'=>[1,'Security+safety wrapper for NTFS disk access'],
351                                                 'captive-install-acquire'=>[1,'Find MS Windows XP driver files for NTFS'],
352 ###                                             'captive-install-fstab'=>[1,'Manage captive-ntfs /etc/fstab entries'],
353                                                 );
354                                 my @r;
355                                 while (@mans) {
356                                         my $file=shift @mans;
357                                         my($section,$name)=@{shift @mans};
358                                         push @r,"<li>".a_href("man/$file.pod.html",$file)."($section) - $name</li>\n";
359                                         }
360                                 @r;
361                                 }
362                         ]}
363                 </ul></li>
364         <li>@{[ a_href 'Resources.pm','Related Pages' ]}</li>
365         <li>@{[ a_href 'Thanks.pm','Thanks' ]}</li>
366 </ul>
367 HERE
368
369
370 exit;
371 }
372 1;