filesystem

1 files changed, 16 insertions, 11 deletions

diff --git a/doc/FileSystem.3 b/doc/FileSystem.3
index 7e49235..9836dea 100644
--- a/doc/FileSystem.3
+++ b/doc/FileSystem.3
@@ -4,13 +4,13 @@
 '\" See the file "license.terms" for information on usage and redistribution
 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
 '\" 
-'\" RCS: @(#) $Id: FileSystem.3,v 1.3 2001/08/23 17:37:07 vincentdarley Exp $
+'\" RCS: @(#) $Id: FileSystem.3,v 1.4 2001/08/30 08:53:14 vincentdarley Exp $
 '\" 
 .so man.macros
 .TH Tcl_FSCopyFile 3 8.4 Tcl "Tcl Library Procedures"
 .BS
 .SH NAME
-Tcl_FSRegister, Tcl_FSUnregister, Tcl_FSData, Tcl_FSCopyFile, Tcl_FSCopyDirectory, Tcl_FSCreateDirectory, Tcl_FSDeleteFile, Tcl_FSRemoveDirectory, Tcl_FSRenameFile, Tcl_FSListVolumes, Tcl_FSEvalFile, Tcl_FSLoadFile, Tcl_FSMatchInDirectory, Tcl_FSReadlink, Tcl_FSLstat, Tcl_FSUtime, Tcl_FSFileAttrsGet, Tcl_FSFileAttrsSet, Tcl_FSFileAttrStrings, Tcl_FSStat, Tcl_FSAccess, Tcl_FSOpenFileChannel, Tcl_FSGetCwd, Tcl_FSChdir, Tcl_FSPathSeparator, Tcl_FSJoinPath, Tcl_FSSplitPath, Tcl_FSEqualPaths, Tcl_FSGetNormalizedPath, Tcl_FSJoinToPath, Tcl_FSConvertToPathType, Tcl_FSGetInternalRep, Tcl_FSGetTranslatedPath, Tcl_FSGetTranslatedStringPath, Tcl_FSNewNativePath, Tcl_FSGetNativePath, Tcl_FSFileSystemInfo \- procedures to interact with any filesystem
+Tcl_FSRegister, Tcl_FSUnregister, Tcl_FSData, Tcl_FSCopyFile, Tcl_FSCopyDirectory, Tcl_FSCreateDirectory, Tcl_FSDeleteFile, Tcl_FSRemoveDirectory, Tcl_FSRenameFile, Tcl_FSListVolumes, Tcl_FSEvalFile, Tcl_FSLoadFile, Tcl_FSMatchInDirectory, Tcl_FSLink, Tcl_FSLstat, Tcl_FSUtime, Tcl_FSFileAttrsGet, Tcl_FSFileAttrsSet, Tcl_FSFileAttrStrings, Tcl_FSStat, Tcl_FSAccess, Tcl_FSOpenFileChannel, Tcl_FSGetCwd, Tcl_FSChdir, Tcl_FSPathSeparator, Tcl_FSJoinPath, Tcl_FSSplitPath, Tcl_FSEqualPaths, Tcl_FSGetNormalizedPath, Tcl_FSJoinToPath, Tcl_FSConvertToPathType, Tcl_FSGetInternalRep, Tcl_FSGetTranslatedPath, Tcl_FSGetTranslatedStringPath, Tcl_FSNewNativePath, Tcl_FSGetNativePath, Tcl_FSFileSystemInfo \- procedures to interact with any filesystem
 .SH SYNOPSIS
 .nf
 \fB#include <tcl.h>\fR
@@ -589,7 +589,7 @@ typedef struct Tcl_Filesystem {
     Tcl_FSOpenFileChannelProc *\fIopenFileChannelProc\fR; 
     Tcl_FSMatchInDirectoryProc *\fImatchInDirectoryProc\fR;  
     Tcl_FSUtimeProc *\fIutimeProc\fR;       
-    Tcl_FSReadlinkProc *\fIreadlinkProc\fR; 
+    Tcl_FSLinkProc *\fIlinkProc\fR; 
     Tcl_FSListVolumesProc *\fIlistVolumesProc\fR;	    
     Tcl_FSFileAttrStringsProc *\fIfileAttrStringsProc\fR;
     Tcl_FSFileAttrsGetProc *\fIfileAttrsGetProc\fR;
@@ -917,20 +917,25 @@ should be changed to the values given in the \fItval\fR structure.
 The return value is a standard Tcl result indicating whether an error
 occurred in the process.
 .PP
-.SH READLINKPROC 
+.SH LINKPROC 
 .PP
-Function to process a 'Tcl_FSReadlink()' call.  Should be implemented
+Function to process a 'Tcl_FSLink()' call.  Should be implemented
 only if the filesystem supports links, and may otherwise be NULL.
 .PP
 .CS
-typedef Tcl_Obj* Tcl_FSReadlinkProc(
-	Tcl_Obj *\fIpathPtr\fR);
+typedef Tcl_Obj* Tcl_FSLinkProc(
+	Tcl_Obj *\fIpathPtr\fR,
+	Tcl_Obj *\fItoPtr\fR);
 .CE
 .PP
-The result is a Tcl_Obj specifying the contents of the symbolic link
-given by 'path', or NULL if the symbolic link could not be read.  The
-result is owned by the caller, which should call Tcl_DecrRefCount when
-the result is no longer needed.
+If \fItoPtr\fR is NULL, the function is being asked to read the
+contents of a link.  The result is a Tcl_Obj specifying the contents of
+the symbolic link given by 'path', or NULL if the symbolic link could
+not be read.  The result is owned by the caller, which should call
+Tcl_DecrRefCount when the result is no longer needed.  If \fItoPtr\fR 
+is not NULL, the function should attempt to create a link.  The result
+in this case should be \fItoPtr\fR if the link was successful and NULL
+otherwise.  In this case the result is not owned by the caller.
 .PP
 .SH LISTVOLUMESPROC	    
 .PP