Improved library, ftp vfs works
authorVince Darley <vincentdarley@sourceforge.net>
Tue, 14 Aug 2001 14:55:15 +0000 (14:55 +0000)
committerVince Darley <vincentdarley@sourceforge.net>
Tue, 14 Aug 2001 14:55:15 +0000 (14:55 +0000)
Readme.txt

index 5e15236697ee1347632a87d66e00bc757713b368..c71444d583abc2d2acf106bb307c2396a0f4b48b 100644 (file)
@@ -7,9 +7,6 @@ course change (although this isn't too likely).  If that happens, it will of
 course require changes to this extension, until the point at which 8.4 goes
 final, when only backwards-compatible changes should occur.
 
-The 'zip' vfs package should work (more or less).  There is a framework for
-a 'ftp' vfs package which needs filling in.
-
 Using this extension, the editor Alphatk can actually auto-mount, view and
 edit (but not save, since they're read-only) the contents of .zip files
 directly (see <http://www.santafe.edu/~vince/Alphatk.html>).
@@ -23,6 +20,31 @@ To install, you probably want to rename the directory 'library' to 'vfs1.0'
 and place it in your Tcl hierarchy, with the necessary shared library
 inside.
 
+None of the vfs's included are 100% complete or optimal yet, so if only for
+that reason, code contributions are very welcome.  Many of them still
+contain various debugging code, etc.  This will be gradually removed and
+the code completely cleaned up and documented as the package evolves.
+
 -- Vince Darley, August 1st 2001
 
+Some of the provided vfs's require the Memchan extension for any operation 
+which involves opening files.
+
+The vfs's currently available are:
+
+--------+-----------------------------------------------------------------
+vfs     |  mount command                       
+--------+-----------------------------------------------------------------
+zip     |  vfs::zip::Mount my.zip local
+ftp     |  vfs::ftp::Mount ftp://user:pass@ftp.foo.com/dir/name/ local
+mk4     |  vfs::mk4::Mount myMk4database local
+test    |  vfs::test::Mount ...
+tclproc |  vfs::tclproc::Mount ::tcl local
+--------+-----------------------------------------------------------------
+
+For file-systems which make use of a local file (e.g. mounting zip or mk4
+archives), it is often most simple to have 'local' be the same name as 
+the archive itself.  The result of this is that Tcl will then see the
+archive as a directory, rather than a file.  Otherwise you might wish
+to create a dummy file/directory called 'local' before mounting.