diff options
Diffstat (limited to 'doc/file.n')
| -rw-r--r-- | doc/file.n | 33 |
1 files changed, 32 insertions, 1 deletions
@@ -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. '\" -'\" RCS: @(#) $Id: file.n,v 1.19 2002/06/20 00:50:48 jenglish Exp $ +'\" RCS: @(#) $Id: file.n,v 1.20 2002/06/21 14:22:28 vincentdarley Exp $ '\" .so man.macros .TH file n 8.3 Tcl "Tcl Built-In Commands" @@ -191,6 +191,37 @@ is always canonical for the current platform: \fB/\fR for Unix and Windows, and \fB:\fR for Macintosh. .RE .TP +\fBfile link ?\fI-linktype\fR? \fIlinkName\fR ?\fItarget\fR? +. +If only one argument is given, that argument is assumed to be +\fIlinkName\fR, and this command returns the value of the link given by +\fIlinkName\fR (i.e. the name of the file it points to). If +\fIlinkName\fR isn't a link or its value cannot be read (as, for example, +seems to be the case with hard links, which look just like ordinary +files), then an error is returned. +. +If 2 arguments are given, then these are assumed to be \fIlinkName\fR and +\fItarget\fR. If \fIlinkName\fR already exists, or if \fItarget\fR +doesn't exist, an error will be returned. Otherwise, Tcl creates a new +link called \fIlinkName\fR which points to the existing filesystem object +at \fItarget\fR, where the type of the link is platform-specific (on Unix +a symbolic link will be the default). This is useful for the case where +the user wishes to create a link in a cross-platform way, and doesn't +care what type of link is created. +. +If the user wishes to make a link of a specific type only, (and signal an +error if for some reason that is not possible), then the optional +\fI-linktype\fR argument should be given. Accepted values for +\fI-linktype\fR are "-symbolic" and "-hard". +. +When creating links on filesystems that either do not support any links, +or do not support the specific type requested, an error message will be +returned. In particular Windows 95, 98 and ME do not support any links +at present, but most Unix platforms support both symbolic and hard links +(the latter for files only), MacOS supports symbolic links and Windows +NT/2000/XP (on NTFS drives) support symbolic directory links and hard +file links. +.TP \fBfile lstat \fIname varName\fR . Same as \fBstat\fR option (see below) except uses the \fIlstat\fR |