aboutsummaryrefslogtreecommitdiff
path: root/pkg/language/doc/mktemp.hlp
diff options
context:
space:
mode:
authorJoe Hunkeler <jhunkeler@gmail.com>2015-08-11 16:51:37 -0400
committerJoe Hunkeler <jhunkeler@gmail.com>2015-08-11 16:51:37 -0400
commit40e5a5811c6ffce9b0974e93cdd927cbcf60c157 (patch)
tree4464880c571602d54f6ae114729bf62a89518057 /pkg/language/doc/mktemp.hlp
downloadiraf-osx-40e5a5811c6ffce9b0974e93cdd927cbcf60c157.tar.gz
Repatch (from linux) of OSX IRAF
Diffstat (limited to 'pkg/language/doc/mktemp.hlp')
-rw-r--r--pkg/language/doc/mktemp.hlp32
1 files changed, 32 insertions, 0 deletions
diff --git a/pkg/language/doc/mktemp.hlp b/pkg/language/doc/mktemp.hlp
new file mode 100644
index 00000000..2c897cc0
--- /dev/null
+++ b/pkg/language/doc/mktemp.hlp
@@ -0,0 +1,32 @@
+.help mktemp Feb86 language
+.ih
+NAME
+mktemp -- make a unique file name
+.ih
+USAGE
+mktemp root
+.ih
+PARAMETERS
+.ls root
+.br
+The root (prefix) for the generated filename.
+.le
+.ih
+DESCRIPTION
+\fIMktemp\fR returns a unique filename string which may be used to create
+a temporary file name. The string is the concatenation of three elements: the
+input argument, the process id, and a final character which changes on
+each call.
+.ih
+EXAMPLES
+1. Create a unique filename with the root "sav" in the logical
+directory "tmp".
+
+ savefile = mktemp ("tmp$sav")
+.ih
+BUGS
+Since some time may elapse between the creation of the filename and the
+creation of a file with that name, there is no guarantee that the name
+will still be unique when it is actually used, however the algorithm used
+to generate the name makes filename collisions unlikely.
+.endhelp