summaryrefslogtreecommitdiffstats
path: root/doc/open.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2021-07-13 19:38:37 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2021-07-13 19:38:37 (GMT)
commit65b685deca1ac743321e7ca505e84b391e5c3133 (patch)
treea02fede3142ab4ea7c1dc7dd8917916656e10c62 /doc/open.n
parent0865a0b6b03cef7f1545ee66e5d53907f9538a4b (diff)
downloadtcl-65b685deca1ac743321e7ca505e84b391e5c3133.zip
tcl-65b685deca1ac743321e7ca505e84b391e5c3133.tar.gz
tcl-65b685deca1ac743321e7ca505e84b391e5c3133.tar.bz2
Added documentation
Diffstat (limited to 'doc/open.n')
-rw-r--r--doc/open.n22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/open.n b/doc/open.n
index c7c8cf6..68e8494 100644
--- a/doc/open.n
+++ b/doc/open.n
@@ -128,6 +128,28 @@ If a new file is created as part of opening it, \fIpermissions\fR
(an integer) is used to set the permissions for the new file in
conjunction with the process's file mode creation mask.
\fIPermissions\fR defaults to 0666.
+.PP
+.VS "8.7, TIP 603"
+When the file opened is an ordinary disk file, the \fBchan configure\fR and
+\fBfconfigure\fR commands can be used to query this additional configuration
+option:
+.TP
+\fB\-stat\fR
+.
+This option, when read, returns a dictionary of values much as is obtained
+from the \fBfile stat\fR command, where that stat information relates to the
+real opened file. Keys in the dictionary may include \fBatime\fR, \fBctime\fR,
+\fBdev\fR, \fBgid\fR, \fBino\fR, \fBmode\fR, \fBmtime\fR, \fBnlink\fR,
+\fBsize\fR, \fBtype\fR, and \fBuid\fR among others; the \fBmtime\fR,
+\fBsize\fR and \fBtype\fR fields are guaranteed to be present and meaningful
+on all platforms; other keys may be present too.
+.RS
+.PP
+\fIImplementation note:\fR This option maps to a call to \fBfstat()\fR on
+POSIX platforms, and to a call to \fBGetFileInformationByHandle()\fR on
+Windows; the information reported is what those system calls produce.
+.RE
+.VE "8.7, TIP 603"
.SH "COMMAND PIPELINES"
.PP
If the first character of \fIfileName\fR is