docs
authorVince Darley <vincentdarley@sourceforge.net>
Wed, 5 Sep 2001 08:55:56 +0000 (08:55 +0000)
committerVince Darley <vincentdarley@sourceforge.net>
Wed, 5 Sep 2001 08:55:56 +0000 (08:55 +0000)
Readme.txt
library/pkgIndex.tcl

index ebcf141d5bf406111c52c994acce3aa4d11a39f0..02c4a809a19e18da0dcd65c6bd1e98327319e7b2 100644 (file)
@@ -11,24 +11,21 @@ including a small library of Tcl code).  The goal of this extension
 is to expose Tcl 8.4's new filesystem C API to the Tcl level.
 
 Since 8.4 is still in alpha, the APIs on which this extension depends may of
-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.  Currently it
-requires a version of Tcl from September 5th 2001 or newer (if it compiles 
+course change.  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.  Currently it requires a version
+of Tcl 8.4a4 or newer from September 5th 2001 or newer (if it compiles
 without warning, you should be fine).
 
 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>).
+directly (see <http://www.santafe.edu/~vince/Alphatk.html>), and you can
+do things like:
 
-The 'tests' directory contains a partially modified version of some of
-Tcl's core tests.  They are modified in that there is a new 'fsIsWritable'
-test constraint, which needs adding to several hundred tests (I've done
-some of that work).
+    file copy ftp://ftp.foo.com/pub/readme.txt .
 
-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.
+With 'tkhtml', writing a web-browser in Tcl should be pretty trivial with
+this extension.    
 
 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
@@ -37,6 +34,18 @@ the code completely cleaned up and documented as the package evolves.
 
 -- Vince Darley, August 1st 2001
 
+Tests and installation
+----------------------
+
+The 'tests' directory contains a partially modified version of some of
+Tcl's core tests.  They are modified in that there is a new 'fsIsWritable'
+test constraint, which needs adding to several hundred tests (I've done
+some of that work).
+
+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 (improvements to makefiles to streamline this much appreciated)
+
 Current implementation
 ----------------------
 
@@ -112,4 +121,7 @@ can be used when desired (for example, 'file copy from to -callback foo'
 would be one approach to handling this).
 
 Bugs in Tcl vfs's are hard to track down, since error messages can't
-necessarily propagate to the toplevel.  Could add a debugging command.
+necessarily propagate to the toplevel.  Could add a debugging command. 
+Alternatively the 'reporting' filesystem in Tcl's test suite can be
+used to aid debugging.
+
index fc802e546e4f5d0bd2ad88f3d170be0c038ad25e..f2f2b5789dab07c062ac2144bbf95e5316141193 100644 (file)
@@ -8,6 +8,13 @@
 # script is sourced, the variable $dir must contain the
 # full path name of this file's directory.
 
+package require Tcl 8.4
+if {[info tclversion] == 8.4} {
+    if {[regexp {8.4a(1|2|3)} [info patchlevel]]} {
+       error "Tcl 8.4a4 (Sept 4 2001) or newer is required"
+    }
+}
+
 lappend auto_path $dir
 if {[info exists tcl_platform(debug)]} {
     package ifneeded vfs 1.0 [list load [file join $dir vfs10d[info sharedlibextension]]]