diff options
Diffstat (limited to 'man3/mkdtemp.3')
| -rw-r--r-- | man3/mkdtemp.3 | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/man3/mkdtemp.3 b/man3/mkdtemp.3 new file mode 100644 index 000000000..66505422b --- /dev/null +++ b/man3/mkdtemp.3 @@ -0,0 +1,67 @@ +.\" Copyright 2001 John Levon <moz@compsoc.man.ac.uk> +.\" Based on mkstemp(3), Copyright 1993 David Metcalfe (david@prism.demon.co.uk) +.\" and GNU libc documentation +.\" +.\" 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. +.\" +.\" 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. +.\" +.\" Formatted or processed versions of this manual, if unaccompanied by +.\" the source, must acknowledge the copyright and authors of this work. +.TH MKDTEMP 3 2001-10-07 "GNU" "Linux Programmer's Manual" +.SH NAME +mkdtemp \- create a unique temporary directory +.SH SYNOPSIS +.nf +.B #include <stdlib.h> +.sp +.BI "char *mkdtemp(char *" template ); +.fi +.SH DESCRIPTION +The \fBmkdtemp()\fP function generates a uniquely-named temporary +directory from \fItemplate\fP. The last six characters of \fItemplate\fP +must be XXXXXX and these are replaced with a string that makes the +.\" FIXME: were the permissions 0700 in all glibc versions ? +directory name unique. The directory is then created with +permissions 0700. +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 \fBmkdtemp()\fP function returns a pointer to the modified template +string on success, and \fBNULL\fP on failure, in which case +.IR errno +is set appropriately. +.SH ERRORS +.TP +.B EINVAL +The last six characters of \fItemplate\fP were not XXXXXX. +Now \fItemplate\fP is unchanged. + +.TP +Also see \fBmkdir(2)\fP for other possible values for \fIerrno\fP. + +.SH "CONFORMING TO" +Introduced in OpenBSD 2.2. +.\" Also in NetBSD 1.4. +Available since glibc 2.1.91. +.SH "SEE ALSO" +.BR mkdir (2), +.BR mkstemp (3), +.BR mktemp (3), +.BR tempnam (3), +.BR tmpfile (3), +.BR tmpnam (3) |