aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHugo Hörnquist <hugo@lysator.liu.se>2023-10-16 15:12:09 +0200
committerHugo Hörnquist <hugo@lysator.liu.se>2023-10-16 15:12:09 +0200
commit305d4df9b8b9c9204bd6f6e1aec016bf39df5b6d (patch)
tree8dc93b73b510c5837464a714f8050982e6883648
parentAdd documentation and tests for table. (diff)
downloadcalp-305d4df9b8b9c9204bd6f6e1aec016bf39df5b6d.tar.gz
calp-305d4df9b8b9c9204bd6f6e1aec016bf39df5b6d.tar.xz
Document call-with-tmpfile.
-rw-r--r--doc/ref/general/io.texi6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/ref/general/io.texi b/doc/ref/general/io.texi
index e7ff51fa..770c21b0 100644
--- a/doc/ref/general/io.texi
+++ b/doc/ref/general/io.texi
@@ -26,6 +26,12 @@ the file, and @code{#f} otherwise.
@end defun
@defun call-with-tmpfile proc [#:tmpl ``/tmp/file-XXXXXXX'']
+Creates a new temporary file, named per the template @var{tmpl}, then
+call @var{proc} with two arguments: an open input-output port to the
+file, and the generated name of the file.
+
+The file will be closed upon the procedures return. However, the file
+@emph{may} be left on disk.
@end defun
@defun read-file path