original/man3/tempnam.3

   1 .\" Copyright (c) 1999 Andries Brouwer (aeb@cwi.nl)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH TEMPNAM 3  2013-04-19 "" "Linux Programmer's Manual"
  26 .SH NAME
  27 tempnam \- create a name for a temporary file
  28 .SH SYNOPSIS
  29 .nf
  30 .B #include <stdio.h>
  31 .sp
  32 .BI "char *tempnam(const char *" dir ", const char *" pfx );
  33 .fi
  34 .sp
  35 .in -4n
  36 Feature Test Macro Requirements for glibc (see
  37 .BR feature_test_macros (7)):
  38 .in
  39 .sp
  40 .BR tempnam ():
  41 _BSD_SOURCE || _SVID_SOURCE
  42 .SH DESCRIPTION
  43 The
  44 .BR tempnam ()
  45 function returns a pointer to a string that is a valid filename,
  46 and such that a file with this name did not exist when
  47 .BR tempnam ()
  48 checked.
  49 The filename suffix of the pathname generated will start with
  50 .I pfx
  51 in case
  52 .I pfx
  53 is a non-NULL string of at most five bytes.
  54 The directory prefix part of the pathname generated is required to
  55 be "appropriate" (often that at least implies writable).
  56
  57 Attempts to find an appropriate directory go through the following
  58 steps:
  59 .TP 3
  60 a)
  61 In case the environment variable
  62 .B TMPDIR
  63 exists and
  64 contains the name of an appropriate directory, that is used.
  65 .TP
  66 b)
  67 Otherwise, if the
  68 .I dir
  69 argument is non-NULL and appropriate, it is used.
  70 .TP
  71 c)
  72 Otherwise,
  73 .I P_tmpdir
  74 (as defined in
  75 .IR <stdio.h> )
  76 is used when appropriate.
  77 .TP
  78 d)
  79 Finally an implementation-defined directory may be used.
  80 .PP
  81 The string returned by
  82 .BR tempnam ()
  83 is allocated using
  84 .BR malloc (3)
  85 and hence should be freed by
  86 .BR free (3).
  87 .SH RETURN VALUE
  88 On success, the
  89 .BR tempnam ()
  90 function returns a pointer to a unique temporary filename.
  91 It returns NULL if a unique name cannot be generated, with
  92 .I errno
  93 set to indicate the cause of the error.
  94 .SH ERRORS
  95 .TP
  96 .B ENOMEM
  97 Allocation of storage failed.
  98 .SH CONFORMING TO
  99 SVr4, 4.3BSD, POSIX.1-2001.
 100 POSIX.1-2008 marks
 101 .BR tempnam ()
 102 as obsolete.
 103 .SH NOTES
 104 Although
 105 .BR tempnam ()
 106 generates names that are difficult to guess,
 107 it is nevertheless possible that between the time that
 108 .BR tempnam ()
 109 returns a pathname, and the time that the program opens it,
 110 another program might create that pathname using
 111 .BR open (2),
 112 or create it as a symbolic link.
 113 This can lead to security holes.
 114 To avoid such possibilities, use the
 115 .BR open (2)
 116 .B O_EXCL
 117 flag to open the pathname.
 118 Or better yet, use
 119 .BR mkstemp (3)
 120 or
 121 .BR tmpfile (3).
 122
 123 SUSv2 does not mention the use of
 124 .BR TMPDIR ;
 125 glibc will use it only
 126 when the program is not set-user-ID.
 127 On SVr4, the directory used under \fBd)\fP is
 128 .I /tmp
 129 (and this is what glibc does).
 130 .LP
 131 Because it dynamically allocates memory used to return the pathname,
 132 .BR tempnam ()
 133 is reentrant, and thus thread safe, unlike
 134 .BR tmpnam (3).
 135 .LP
 136 The
 137 .BR tempnam ()
 138 function generates a different string each time it is called,
 139 up to
 140 .B TMP_MAX
 141 (defined in
 142 .IR <stdio.h> )
 143 times.
 144 If it is called more than
 145 .B TMP_MAX
 146 times,
 147 the behavior is implementation defined.
 148 .LP
 149 .BR tempnam ()
 150 uses at most the first five bytes from
 151 .IR pfx .
 152
 153 The glibc implementation of
 154 .BR tempnam ()
 155 will fail with the error
 156 .B EEXIST
 157 upon failure to find a unique name.
 158 .SH BUGS
 159 The precise meaning of "appropriate" is undefined;
 160 it is unspecified how accessibility of a directory is determined.
 161
 162 Never use this function.
 163 Use
 164 .BR mkstemp (3)
 165 or
 166 .BR tmpfile (3)
 167 instead.
 168 .SH SEE ALSO
 169 .BR mkstemp (3),
 170 .BR mktemp (3),
 171 .BR tmpfile (3),
 172 .BR tmpnam (3)