man3/mkdtemp.3

   1 .\" Copyright 2001 John Levon <moz@compsoc.man.ac.uk>
   2 .\" Based on mkstemp(3), Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   3 .\" and GNU libc documentation
   4 .\"
   5 .\" %%%LICENSE_START(VERBATIM)
   6 .\" Permission is granted to make and distribute verbatim copies of this
   7 .\" manual provided the copyright notice and this permission notice are
   8 .\" preserved on all copies.
   9 .\"
  10 .\" Permission is granted to copy and distribute modified versions of this
  11 .\" manual under the conditions for verbatim copying, provided that the
  12 .\" entire resulting derived work is distributed under the terms of a
  13 .\" permission notice identical to this one.
  14 .\"
  15 .\" Since the Linux kernel and libraries are constantly changing, this
  16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  17 .\" responsibility for errors or omissions, or for damages resulting from
  18 .\" the use of the information contained herein.  The author(s) may not
  19 .\" have taken the same level of care in the production of this manual,
  20 .\" which is licensed free of charge, as they might when working
  21 .\" professionally.
  22 .\"
  23 .\" Formatted or processed versions of this manual, if unaccompanied by
  24 .\" the source, must acknowledge the copyright and authors of this work.
  25 .\" %%%LICENSE_END
  26 .TH MKDTEMP 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  27 .SH NAME
  28 mkdtemp \- create a unique temporary directory
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <stdlib.h>
  32 .PP
  33 .BI "char *mkdtemp(char *" template );
  34 .fi
  35 .PP
  36 .RS -4
  37 Feature Test Macro Requirements for glibc (see
  38 .BR feature_test_macros (7)):
  39 .RE
  40 .PP
  41 .BR mkdtemp ():
  42 .nf
  43     /* Since glibc 2.19: */ _DEFAULT_SOURCE
  44         || /* Glibc 2.19 and earlier: */ _BSD_SOURCE
  45         || /* Since glibc 2.10: */ _POSIX_C_SOURCE >= 200809L
  46 .fi
  47 .SH DESCRIPTION
  48 The
  49 .BR mkdtemp ()
  50 function generates a uniquely named temporary
  51 directory from \fItemplate\fP.
  52 The last six characters of \fItemplate\fP
  53 must be XXXXXX and these are replaced with a string that makes the
  54 directory name unique.
  55 The directory is then created with
  56 permissions 0700.
  57 Since it will be modified,
  58 .I template
  59 must not be a string constant, but should be declared as a character array.
  60 .SH RETURN VALUE
  61 The
  62 .BR mkdtemp ()
  63 function returns a pointer to the modified template
  64 string on success, and NULL on failure, in which case
  65 .I errno
  66 is set to indicate the error.
  67 .SH ERRORS
  68 .TP
  69 .B EINVAL
  70 The last six characters of \fItemplate\fP were not XXXXXX.
  71 Now \fItemplate\fP is unchanged.
  72 .PP
  73 Also see
  74 .BR mkdir (2)
  75 for other possible values for \fIerrno\fP.
  76 .SH VERSIONS
  77 Available since glibc 2.1.91.
  78 .SH ATTRIBUTES
  79 For an explanation of the terms used in this section, see
  80 .BR attributes (7).
  81 .ad l
  82 .nh
  83 .TS
  84 allbox;
  85 lbx lb lb
  86 l l l.
  87 Interface       Attribute       Value
  88 T{
  89 .BR mkdtemp ()
  90 T}      Thread safety   MT-Safe
  91 .TE
  92 .hy
  93 .ad
  94 .sp 1
  95 .SH CONFORMING TO
  96 POSIX.1-2008.
  97 This function is present on the BSDs.
  98 .\" As at 2006, this function is being considered for a revision of POSIX.1
  99 .\" Also in NetBSD 1.4.
 100 .SH SEE ALSO
 101 .BR mktemp (1),
 102 .BR mkdir (2),
 103 .BR mkstemp (3),
 104 .BR mktemp (3),
 105 .BR tempnam (3),
 106 .BR tmpfile (3),
 107 .BR tmpnam (3)