diff options
Diffstat (limited to 'contrib/tcl/doc/Translate.3')
| -rw-r--r-- | contrib/tcl/doc/Translate.3 | 12 |
1 files changed, 1 insertions, 11 deletions
diff --git a/contrib/tcl/doc/Translate.3 b/contrib/tcl/doc/Translate.3 index 81a16dae2a45..6330ee9e2c63 100644 --- a/contrib/tcl/doc/Translate.3 +++ b/contrib/tcl/doc/Translate.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" SCCS: @(#) Translate.3 1.21 96/03/25 20:08:58 +'\" SCCS: @(#) Translate.3 1.22 96/08/26 12:59:51 '\" .so man.macros .TH Tcl_TranslateFileName 3 7.5 Tcl "Tcl Library Procedures" @@ -17,9 +17,7 @@ Tcl_TranslateFileName \- convert file name to native form and replace tilde with \fB#include <tcl.h>\fR .sp char * -.VS \fBTcl_TranslateFileName\fR(\fIinterp\fR, \fIname\fR, \fIbufferPtr\fR) -.VE .SH ARGUMENTS .AS Tcl_DString *bufferPtr .AP Tcl_Interp *interp in @@ -27,17 +25,14 @@ Interpreter in which to report an error, if any. .AP char *name in File name, which may start with a ``~''. .AP Tcl_DString *bufferPtr in/out -.VS If needed, this dynamic string is used to store the new file name. At the time of the call it should be uninitialized or empty. The caller must eventually call \fBTcl_DStringFree\fR to free up anything stored here. -.VE .BE .SH DESCRIPTION .PP -.VS This utility procedure translates a file name to a form suitable for passing to the local operating system. It converts network names into native form and does tilde substitution. @@ -53,24 +48,19 @@ placed in \fI*bufferPtr\fR. The caller need not know whether or not \fBTcl_TranslateFileName\fR actually used the string; \fBTcl_TranslateFileName\fR initializes \fI*bufferPtr\fR even if it doesn't use it, so the call to \fBTcl_DStringFree\fR will be safe in either case. -.VE .PP If an error occurs (e.g. because there was no user by the given name) then NULL is returned and an error message will be left at \fIinterp->result\fR. -.VS When an error occurs, \fBTcl_TranslateFileName\fR frees the dynamic string itself so that the caller need not call \fBTcl_DStringFree\fR. -.VE .PP The caller is responsible for making sure that \fIinterp->result\fR has its default empty value when \fBTcl_TranslateFileName\fR is invoked. -.VS .SH "SEE ALSO" filename -.VE .SH KEYWORDS file name, home directory, tilde, translate, user |