From 29646c6a123643d3deb18e06783f7f0fe8b710f4 Mon Sep 17 00:00:00 2001 From: Vince Darley Date: Tue, 28 Jan 2003 12:51:25 +0000 Subject: [PATCH] docs --- doc/vfslib.n | 38 +++++++++++++++++++++++++++++--------- 1 file changed, 29 insertions(+), 9 deletions(-) diff --git a/doc/vfslib.n b/doc/vfslib.n index f84425d..96f111a 100644 --- a/doc/vfslib.n +++ b/doc/vfslib.n @@ -15,10 +15,28 @@ .sp \fBpackage require vfs ?1.0?\fR .sp +\fBpackage require vfs::zip ?1.0?\fR +.sp +\fBpackage require vfs::mk4 ?1.0?\fR +.sp +\fBpackage require vfs::tar ?0.9?\fR +.sp +\fBpackage require vfs::ftp ?1.0?\fR +.sp +\fBpackage require vfs::ns ?1.0?\fR +.sp +\fBpackage require vfs::webdav ?0.1?\fR +.sp +\fBpackage require vfs::http ?0.5?\fR +.sp +\fBpackage require vfs::urltype ?1.0?\fR +.sp \fBvfs::zip::Mount\fR \fIpath\fR \fIto\fR .sp \fBvfs::ftp::Mount\fR \fIpath\fR \fIto\fR .sp +\fBvfs::tar::Mount\fR \fIpath\fR \fIto\fR +.sp \fBvfs::http::Mount\fR \fIpath\fR \fIto\fR .sp \fBvfs::mk4::Mount\fR \fIpath\fR \fIto\fR @@ -30,22 +48,24 @@ .BE .SH DESCRIPTION .PP -The \fB::vfs\fR package includes a library of Tcl code, informally -known as 'vfslib' which can be accessed through \fBpackage require -vfs\fP. +The \fB::vfs\fR package includes a library of Tcl code, implementing +a number of different virtual filesystems. Each of these exists +as its own package, and can be accessed through \fBpackage require +vfs::NAME\fP. The whole set of virtual filesystems is known informally +as 'vfslib' .PP .SH SUPPORTED VFS TYPES .PP -The current supported types are ftp, http, zip, mk4, ns. In addition -there is the ability to mount any 'urltype' as a new volume, provided -an appropriate vfs is supported. This means that you can treat +The current supported types are ftp, tar, http, zip, mk4, ns, webdav. In +addition there is the ability to mount any 'urltype' as a new volume, +provided an appropriate vfs is supported. This means that you can treat 'ftp://', 'http://' and 'file://' urls as files. To do this, simply evaluate the command .PP \fIvfs::urltype::Mount ftp\fR .PP -for instance. Any access inside the new volume will result in an -attempt to mount a new path through 'vfs::${type}::Mount', which must +for instance. Any access inside the new volume will result in an attempt +to require a package through 'package require vfs::${type}', which must therefore exist, or errors will be thrown. .PP .SH LIMITATIONS @@ -53,6 +73,6 @@ therefore exist, or errors will be thrown. Most of the vfs types listed above have not been very well debugged as yet. Please test them! .SH KEYWORDS -vfs, vfslib, filesystem, zip, ftp, http, file +vfs, vfslib, filesystem, zip, tar, webdav, namespace, ftp, http, file -- 2.23.0