summaryrefslogtreecommitdiffstats
path: root/doc/Translate.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2011-07-18 23:45:15 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2011-07-18 23:45:15 (GMT)
commit78ab9d722b4e992f8d02002585102f6c7ec7db1a (patch)
treef6c276fef4010ddf0f97541f9e016a3c1e19d569 /doc/Translate.3
parent749ffd3fb84b317505043723c16c486bdbc0403a (diff)
downloadtcl-78ab9d722b4e992f8d02002585102f6c7ec7db1a.zip
tcl-78ab9d722b4e992f8d02002585102f6c7ec7db1a.tar.gz
tcl-78ab9d722b4e992f8d02002585102f6c7ec7db1a.tar.bz2
The final parts of my doc improvement project
Diffstat (limited to 'doc/Translate.3')
-rw-r--r--doc/Translate.311
1 files changed, 4 insertions, 7 deletions
diff --git a/doc/Translate.3 b/doc/Translate.3
index d434cda..55233c3 100644
--- a/doc/Translate.3
+++ b/doc/Translate.3
@@ -29,7 +29,6 @@ At the time of the call it should be uninitialized or free. The
caller must eventually call \fBTcl_DStringFree\fR to free up
anything stored here.
.BE
-
.SH DESCRIPTION
.PP
This utility procedure translates a file name to a platform-specific form
@@ -38,11 +37,11 @@ passing to the local operating system. In particular, it converts
network names into native form and does tilde substitution.
.PP
However, with the advent of the newer \fBTcl_FSGetNormalizedPath\fR and
-\fBTcl_GetNativePath\fR, there is no longer any need to use this
-procedure. In particular, \fBTcl_GetNativePath\fR performs all the
+\fBTcl_FSGetNativePath\fR, there is no longer any need to use this
+procedure. In particular, \fBTcl_FSGetNativePath\fR performs all the
necessary translation and encoding conversion, is virtual-filesystem
aware, and caches the native result for faster repeated calls.
-Finally \fBTcl_GetNativePath\fR does not require you to free anything
+Finally \fBTcl_FSGetNativePath\fR does not require you to free anything
afterwards.
.PP
If
@@ -66,9 +65,7 @@ frees the dynamic string itself so that the caller need not call
.PP
The caller is responsible for making sure that the interpreter's result
has its default empty value when \fBTcl_TranslateFileName\fR is invoked.
-
.SH "SEE ALSO"
-filename
-
+filename(n)
.SH KEYWORDS
file name, home directory, tilde, translate, user