summaryrefslogtreecommitdiffstats
path: root/man/man3/mktemp.3
diff options
context:
space:
mode:
Diffstat (limited to 'man/man3/mktemp.3')
-rw-r--r--man/man3/mktemp.3118
1 files changed, 118 insertions, 0 deletions
diff --git a/man/man3/mktemp.3 b/man/man3/mktemp.3
new file mode 100644
index 0000000..54e5b1f
--- /dev/null
+++ b/man/man3/mktemp.3
@@ -0,0 +1,118 @@
+'\" t
+.\" Copyright (C) 1993 David Metcalfe (david@prism.demon.co.uk)
+.\"
+.\" SPDX-License-Identifier: Linux-man-pages-copyleft
+.\"
+.\" References consulted:
+.\" Linux libc source code
+.\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
+.\" 386BSD man pages
+.\" Modified Sat Jul 24 18:48:06 1993 by Rik Faith (faith@cs.unc.edu)
+.\" Modified Fri Jun 23 01:26:34 1995 by Andries Brouwer (aeb@cwi.nl)
+.\" (prompted by Scott Burkett <scottb@IntNet.net>)
+.\" Modified Sun Mar 28 23:44:38 1999 by Andries Brouwer (aeb@cwi.nl)
+.\"
+.TH mktemp 3 2024-05-02 "Linux man-pages (unreleased)"
+.SH NAME
+mktemp \- make a unique temporary filename
+.SH LIBRARY
+Standard C library
+.RI ( libc ", " \-lc )
+.SH SYNOPSIS
+.nf
+.B #include <stdlib.h>
+.P
+.BI "char *mktemp(char *" template );
+.fi
+.P
+.RS -4
+Feature Test Macro Requirements for glibc (see
+.BR feature_test_macros (7)):
+.RE
+.P
+.BR mktemp ():
+.nf
+ Since glibc 2.12:
+ (_XOPEN_SOURCE >= 500) && ! (_POSIX_C_SOURCE >= 200112L)
+ || /* glibc >= 2.19: */ _DEFAULT_SOURCE
+ || /* glibc <= 2.19: */ _SVID_SOURCE || _BSD_SOURCE
+ Before glibc 2.12:
+ _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE >= 500
+.\" || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
+.fi
+.SH DESCRIPTION
+.IR "Never use this function" ;
+see BUGS.
+.P
+The
+.BR mktemp ()
+function generates a unique temporary filename
+from \fItemplate\fP.
+The last six characters of \fItemplate\fP must
+be XXXXXX and these are replaced with a string that makes the
+filename unique.
+Since it will be modified,
+.I template
+must not be a string constant, but should be declared as a character array.
+.SH RETURN VALUE
+The
+.BR mktemp ()
+function always returns \fItemplate\fP.
+If a unique name was created, the last six bytes of \fItemplate\fP will
+have been modified in such a way that the resulting name is unique
+(i.e., does not exist already)
+If a unique name could not be created,
+\fItemplate\fP is made an empty string, and
+.I errno
+is set to indicate the error.
+.SH ERRORS
+.TP
+.B EINVAL
+The last six characters of \fItemplate\fP were not XXXXXX.
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lbx lb lb
+l l l.
+Interface Attribute Value
+T{
+.na
+.nh
+.BR mktemp ()
+T} Thread safety MT-Safe
+.TE
+.SH STANDARDS
+None.
+.SH HISTORY
+4.3BSD, POSIX.1-2001.
+Removed in POSIX.1-2008.
+.\" .SH NOTES
+.\" The prototype is in
+.\" .I <unistd.h>
+.\" for libc4, libc5, glibc1; glibc2 follows the Single UNIX Specification
+.\" and has the prototype in
+.\" .IR <stdlib.h> .
+.SH BUGS
+Never use
+.BR mktemp ().
+Some implementations follow 4.3BSD
+and replace XXXXXX by the current process ID and a single letter,
+so that at most 26 different names can be returned.
+Since on the one hand the names are easy to guess, and on the other
+hand there is a race between testing whether the name exists and
+opening the file, every use of
+.BR mktemp ()
+is a security risk.
+The race is avoided by
+.BR mkstemp (3)
+and
+.BR mkdtemp (3).
+.SH SEE ALSO
+.BR mktemp (1),
+.BR mkdtemp (3),
+.BR mkstemp (3),
+.BR tempnam (3),
+.BR tmpfile (3),
+.BR tmpnam (3)