2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
|
2008-06-12 05:18:05 +00:00
|
|
|
.\" and Copyright (C) 2008, Michael Kerrisk <mtk.manpages@gmail.com>
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
|
|
|
.\" 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:48 1993 by Rik Faith (faith@cs.unc.edu)
|
|
|
|
.\" Modified 980310, aeb
|
|
|
|
.\" Modified 990328, aeb
|
2008-06-12 05:18:05 +00:00
|
|
|
.\" 2008-06-19, mtk, Added mkostemp(); various other changes
|
2004-11-03 13:51:07 +00:00
|
|
|
.\"
|
chdir.2, chmod.2, chown.2, gethostname.2, getsid.2, pread.2, setpgid.2, sigaltstack.2, truncate.2, wait.2, dirfd.3, getsubopt.3, mkdtemp.3, mkstemp.3, siginterrupt.3, strdup.3: tstamp
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-09-26 15:43:00 +00:00
|
|
|
.TH MKSTEMP 3 2010-09-26 "GNU" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
2008-06-12 05:18:05 +00:00
|
|
|
mkstemp, mkostemp \- create a unique temporary file
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <stdlib.h>
|
|
|
|
.sp
|
|
|
|
.BI "int mkstemp(char *" template );
|
2008-06-12 05:18:05 +00:00
|
|
|
.sp
|
|
|
|
.BI "int mkostemp (char *" template ", int " flags );
|
2010-06-19 03:19:44 +00:00
|
|
|
.sp
|
|
|
|
.BI "int mkstemps(char *" template ", int " suffixlen );
|
|
|
|
.sp
|
|
|
|
.BI "int mkostemps(char *" template ", int " suffixlen ", int " flags );
|
2004-11-03 13:51:07 +00:00
|
|
|
.fi
|
2007-07-08 12:11:40 +00:00
|
|
|
.sp
|
|
|
|
.in -4n
|
|
|
|
Feature Test Macro Requirements for glibc (see
|
|
|
|
.BR feature_test_macros (7)):
|
|
|
|
.in
|
|
|
|
.sp
|
|
|
|
.BR mkstemp ():
|
2010-09-17 14:22:33 +00:00
|
|
|
.ad l
|
|
|
|
.RS 4
|
|
|
|
.PD 0
|
brk.2, chroot.2, faccessat.2, fchmodat.2, fchownat.2, fstatat.2, futimesat.2, getdtablesize.2, getpagesize.2, getsid.2, linkat.2, mkdirat.2, mknodat.2, openat.2, pread.2, readlinkat.2, renameat.2, setpgid.2, sigaltstack.2, symlinkat.2, sync.2, timer_create.2, timer_delete.2, timer_getoverrun.2, timer_settime.2, unlinkat.2, utimensat.2, vfork.2, acosh.3, asinh.3, atanh.3, dirfd.3, dprintf.3, ecvt.3, expm1.3, fexecve.3, fmemopen.3, gcvt.3, getcwd.3, gethostid.3, getpass.3, getsubopt.3, getw.3, mbsnrtowcs.3, mkfifoat.3, mkstemp.3, mktemp.3, opendir.3, posix_memalign.3, rint.3, siginterrupt.3, stpcpy.3, stpncpy.3, strdup.3, strerror.3, strnlen.3, strsignal.3, strtol.3, strtoul.3, ualarm.3, usleep.3, wcpcpy.3, wcpncpy.3, wcscasecmp.3, wcsdup.3, wcsncasecmp.3, wcsnlen.3, wcsnrtombs.3: ffix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-09-19 06:02:38 +00:00
|
|
|
_BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
|
|
|
|
_XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
|
chdir.2, chmod.2, chown.2, gethostname.2, getsid.2, pread.2, setpgid.2, sigaltstack.2, stat.2, truncate.2, wait.2, dirfd.3, getsubopt.3, mkdtemp.3, mkstemp.3, siginterrupt.3, strdup.3: Simplify feature test macro requirements
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-09-26 15:16:57 +00:00
|
|
|
.br
|
|
|
|
|| /* Since glibc 2.12: */ _POSIX_C_SOURCE\ >=\ 200112L
|
2010-09-17 14:22:33 +00:00
|
|
|
.PD
|
|
|
|
.RE
|
|
|
|
.ad b
|
|
|
|
.PP
|
2008-06-12 05:18:05 +00:00
|
|
|
.BR mkostemp ():
|
|
|
|
_GNU_SOURCE
|
2010-06-19 03:19:44 +00:00
|
|
|
.br
|
|
|
|
.BR mkstemps ():
|
|
|
|
_BSD_SOURCE || _SVID_SOURCE
|
|
|
|
.br
|
|
|
|
.BR mkostemps ():
|
|
|
|
_GNU_SOURCE
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH DESCRIPTION
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR mkstemp ()
|
2008-06-12 05:18:05 +00:00
|
|
|
function generates a unique temporary filename from
|
|
|
|
.IR template ,
|
|
|
|
creates and opens the file,
|
|
|
|
and returns an open file descriptor for the file.
|
|
|
|
|
|
|
|
The last six characters of
|
|
|
|
.I template
|
|
|
|
must be "XXXXXX" and these are replaced with a string that makes the
|
2007-04-12 22:42:49 +00:00
|
|
|
filename unique.
|
2004-11-03 13:51:07 +00:00
|
|
|
Since it will be modified,
|
|
|
|
.I template
|
|
|
|
must not be a string constant, but should be declared as a character array.
|
2008-06-12 05:18:05 +00:00
|
|
|
|
|
|
|
The file is created with
|
|
|
|
permissions 0600, that is, read plus write for owner only.
|
|
|
|
(In glibc versions 2.06 and earlier, the file is created with permissions 0666,
|
|
|
|
that is, read and write for all users.)
|
|
|
|
The returned file descriptor provides both read and write access to the file.
|
2007-04-12 22:42:49 +00:00
|
|
|
The file is opened with the
|
2006-05-22 21:32:54 +00:00
|
|
|
.BR open (2)
|
2007-04-12 22:42:49 +00:00
|
|
|
.B O_EXCL
|
2008-06-12 05:18:05 +00:00
|
|
|
flag, guaranteeing that the caller is the process that creates the file.
|
|
|
|
|
2010-06-19 03:19:44 +00:00
|
|
|
The
|
2008-06-12 05:18:05 +00:00
|
|
|
.BR mkostemp ()
|
2010-06-19 03:19:44 +00:00
|
|
|
function is like
|
2008-06-12 05:18:05 +00:00
|
|
|
.BR mkstemp (),
|
|
|
|
with the difference that flags as for
|
|
|
|
.BR open (2)
|
|
|
|
may be specified in
|
|
|
|
.IR flags
|
|
|
|
(e.g.,
|
|
|
|
.BR O_APPEND ,
|
|
|
|
.BR O_SYNC ).
|
2010-06-19 03:19:44 +00:00
|
|
|
|
|
|
|
The
|
|
|
|
.BR mkstemps ()
|
|
|
|
function is like
|
|
|
|
.BR mkstemp (),
|
|
|
|
except that the string in
|
|
|
|
.I template
|
|
|
|
contains a suffix of
|
|
|
|
.I suffixlen
|
|
|
|
characters.
|
|
|
|
Thus,
|
|
|
|
.I template
|
|
|
|
is of the form
|
|
|
|
.IR "prefixXXXXXXsuffix" ,
|
|
|
|
and the string XXXXXX is modified as for
|
|
|
|
.BR mkstemp ().
|
|
|
|
|
|
|
|
The
|
|
|
|
.BR mkostemps ()
|
|
|
|
function is to
|
|
|
|
.BR mkstemps ()
|
|
|
|
as
|
|
|
|
.BR mkostemp ()
|
|
|
|
is to
|
|
|
|
.BR mkstemp ().
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "RETURN VALUE"
|
2008-06-12 05:18:05 +00:00
|
|
|
On success, these functions return the file descriptor
|
2004-12-20 12:24:06 +00:00
|
|
|
of the temporary file.
|
|
|
|
On error, \-1 is returned, and
|
|
|
|
.I errno
|
|
|
|
is set appropriately.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH ERRORS
|
|
|
|
.TP
|
|
|
|
.B EEXIST
|
|
|
|
Could not create a unique temporary filename.
|
|
|
|
Now the contents of \fItemplate\fP are undefined.
|
|
|
|
.TP
|
|
|
|
.B EINVAL
|
2010-06-19 03:19:44 +00:00
|
|
|
For
|
|
|
|
.BR mkstemp ()
|
|
|
|
and
|
|
|
|
.BR mkostemp ():
|
|
|
|
The last six characters of \fItemplate\fP were not XXXXXX;
|
|
|
|
now \fItemplate\fP is unchanged.
|
|
|
|
.sp
|
|
|
|
For
|
|
|
|
.BR mkstemps ()
|
|
|
|
and
|
|
|
|
.BR mkostemps ()
|
|
|
|
.I template
|
|
|
|
is less than
|
|
|
|
.I "(6 + suffixlen)"
|
|
|
|
characters long, or the last 6 characters before the suffix in
|
|
|
|
.I template
|
|
|
|
were not XXXXXX.
|
2008-06-12 05:18:05 +00:00
|
|
|
.PP
|
|
|
|
These functions may also fail with any of the errors described for
|
|
|
|
.BR open (2).
|
|
|
|
.SH VERSIONS
|
|
|
|
.BR mkostemp ()
|
|
|
|
is available since glibc 2.7.
|
2010-06-19 03:19:44 +00:00
|
|
|
.BR mkstemps ()
|
|
|
|
and
|
|
|
|
.BR mkostemps ()
|
|
|
|
are available since glibc 2.11.
|
2007-05-19 04:30:20 +00:00
|
|
|
.SH "CONFORMING TO"
|
2008-06-12 05:18:05 +00:00
|
|
|
.BR mkstemp ():
|
|
|
|
4.3BSD, POSIX.1-2001.
|
2010-06-19 03:19:44 +00:00
|
|
|
|
|
|
|
.BR mkstemps ():
|
|
|
|
unstandardized, but appears on several other systems.
|
|
|
|
.\" mkstemps() appears to be at least on the BSDs, Mac OS X, Solaris,
|
|
|
|
.\" and Tru64.
|
|
|
|
|
|
|
|
.BR mkostemp ()
|
|
|
|
and
|
|
|
|
.BR mkostemps ():
|
|
|
|
are glibc extensions.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NOTES
|
2008-06-12 05:18:05 +00:00
|
|
|
The old behavior of creating a file with mode 0666 may be
|
intro.1, time.1, accept.2, bind.2, connect.2, execve.2, flock.2, getdents.2, getpriority.2, getuid.2, intro.2, ioctl.2, mincore.2, mknod.2, personality.2, ptrace.2, read.2, recv.2, select_tut.2, send.2, sendfile.2, shmctl.2, sigaction.2, signal.2, stat.2, times.2, truncate.2, umask.2, wait.2, MB_CUR_MAX.3, MB_LEN_MAX.3, argz_add.3, btowc.3, clearenv.3, clock.3, cmsg.3, end.3, endian.3, errno.3, exit.3, fgetwc.3, fgetws.3, fopen.3, fputwc.3, fputws.3, fseek.3, fwide.3, getfsent.3, getgrnam.3, gethostid.3, getipnodebyname.3, getmntent.3, getpwnam.3, getwchar.3, grantpt.3, iconv.3, iconv_close.3, iconv_open.3, insque.3, intro.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, malloc.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mkstemp.3, mktemp.3, nl_langinfo.3, openpty.3, posix_openpt.3, printf.3, ptsname.3, putwchar.3, qecvt.3, rcmd.3, readdir.3, rexec.3, rpc.3, setnetgrent.3, shm_open.3, sigpause.3, stdin.3, stpcpy.3, strftime.3, strptime.3, syslog.3, towctrans.3, towlower.3, towupper.3, ttyslot.3, ungetwc.3, unlocked_stdio.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wprintf.3, console_ioctl.4, pts.4, elf.5, filesystems.5, hosts.5, proc.5, ttytype.5, boot.7, capabilities.7, credentials.7, epoll.7, glob.7, koi8-r.7, path_resolution.7, pty.7, signal.7, suffixes.7, time.7, unicode.7, unix.7, uri.7, utf-8.7: global fix: s/Unix/UNIX/
The man pages were rather inconsistent in the use of "Unix"
versus "UNIX". Let's go with the trademark usage.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-12 04:45:38 +00:00
|
|
|
a security risk, especially since other UNIX flavors use 0600,
|
2004-11-03 13:51:07 +00:00
|
|
|
and somebody might overlook this detail when porting programs.
|
|
|
|
|
2008-06-12 05:18:05 +00:00
|
|
|
More generally, the POSIX specification of
|
|
|
|
.BR mkstemp ()
|
|
|
|
does not say anything
|
|
|
|
about file modes, so the application should make sure its
|
|
|
|
file mode creation mask (see
|
|
|
|
.BR umask (2))
|
2004-11-03 13:51:07 +00:00
|
|
|
is set appropriately before calling
|
2008-06-12 05:18:05 +00:00
|
|
|
.BR mkstemp ()
|
|
|
|
(and
|
|
|
|
.BR mkostemp ()).
|
2007-05-16 02:50:51 +00:00
|
|
|
|
2008-06-12 05:18:05 +00:00
|
|
|
The prototype for
|
|
|
|
.BR mktemp ()
|
|
|
|
is in
|
2004-11-03 13:51:07 +00:00
|
|
|
.I <unistd.h>
|
2007-05-16 02:50:51 +00:00
|
|
|
for libc4, libc5, glibc1; glibc2 follows POSIX.1 and has the prototype in
|
2004-11-03 13:51:07 +00:00
|
|
|
.IR <stdlib.h> .
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR mkdtemp (3),
|
|
|
|
.BR mktemp (3),
|
|
|
|
.BR tempnam (3),
|
|
|
|
.BR tmpfile (3),
|
|
|
|
.BR tmpnam (3)
|