summaryrefslogtreecommitdiffstats
path: root/doc/FileSystem.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/FileSystem.3')
-rw-r--r--doc/FileSystem.39
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/FileSystem.3 b/doc/FileSystem.3
index 0853ccc..c7113b9 100644
--- a/doc/FileSystem.3
+++ b/doc/FileSystem.3
@@ -4,7 +4,7 @@
'\" 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.33 2003/06/23 10:45:54 vincentdarley Exp $
+'\" RCS: @(#) $Id: FileSystem.3,v 1.34 2003/07/28 12:16:02 vincentdarley Exp $
'\"
.so man.macros
.TH Filesystem 3 8.4 Tcl "Tcl Library Procedures"
@@ -550,10 +550,15 @@ If the translation succeeds (i.e. the object is a valid path), then it
is returned. Otherwise NULL will be returned, and an error message may
be left in the interpreter. A "translated" path is one which
contains no "~" or "~user" sequences (these have been expanded to
-their current representation in the filesystem).
+their current representation in the filesystem). This function is of
+little practical use, and \fBTcl_FSGetNormalizedPath\fR or
+\fBTcl_GetNativePath\fR are usually better functions to use for most
+purposes.
.PP
\fBTcl_FSGetTranslatedStringPath\fR does the same as
\fBTcl_FSGetTranslatedPath\fR, but returns a character string or NULL.
+Again, \fBTcl_FSGetNormalizedPath\fR or \fBTcl_GetNativePath\fR are
+usually better functions to use for most purposes.
.PP
\fBTcl_FSNewNativePath\fR performs something like that reverse of the
usual obj->path->nativerep conversions. If some code retrieves a path