man3/putenv.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   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 .\" References consulted:
  26 .\"     Linux libc source code
  27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  28 .\"     386BSD man pages
  29 .\"     Single UNIX Specification, Version 2
  30 .\" Modified Thu Apr  8 15:00:12 1993, David Metcalfe
  31 .\" Modified Sat Jul 24 18:44:45 1993, Rik Faith (faith@cs.unc.edu)
  32 .\" Modified Fri Feb 14 21:47:50 1997 by Andries Brouwer (aeb@cwi.nl)
  33 .\" Modified Mon Oct 11 11:11:11 1999 by Andries Brouwer (aeb@cwi.nl)
  34 .\" Modified Wed Nov 10 00:02:26 1999 by Andries Brouwer (aeb@cwi.nl)
  35 .\" Modified Sun May 20 22:17:20 2001 by Andries Brouwer (aeb@cwi.nl)
  36 .TH PUTENV 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  37 .SH NAME
  38 putenv \- change or add an environment variable
  39 .SH SYNOPSIS
  40 .nf
  41 .B #include <stdlib.h>
  42 .PP
  43 .BI "int putenv(char *" string );
  44 .\" Not: const char *
  45 .fi
  46 .PP
  47 .RS -4
  48 Feature Test Macro Requirements for glibc (see
  49 .BR feature_test_macros (7)):
  50 .RE
  51 .PP
  52 .BR putenv ():
  53 .nf
  54     _XOPEN_SOURCE
  55         || /* Glibc since 2.19: */ _DEFAULT_SOURCE
  56         || /* Glibc <= 2.19: */ _SVID_SOURCE
  57 .fi
  58 .SH DESCRIPTION
  59 The
  60 .BR putenv ()
  61 function adds or changes the value of environment
  62 variables.
  63 The argument \fIstring\fP is of the form \fIname\fP=\fIvalue\fP.
  64 If \fIname\fP does not already exist in the environment, then
  65 \fIstring\fP is added to the environment.
  66 If \fIname\fP does exist,
  67 then the value of \fIname\fP in the environment is changed to
  68 \fIvalue\fP.
  69 The string pointed to by \fIstring\fP becomes part of the environment,
  70 so altering the string changes the environment.
  71 .SH RETURN VALUE
  72 The
  73 .BR putenv ()
  74 function returns zero on success.
  75 On failure, it returns a nonzero value, and
  76 .I errno
  77 is set to indicate the error.
  78 .SH ERRORS
  79 .TP
  80 .B ENOMEM
  81 Insufficient space to allocate new environment.
  82 .SH ATTRIBUTES
  83 For an explanation of the terms used in this section, see
  84 .BR attributes (7).
  85 .ad l
  86 .nh
  87 .TS
  88 allbox;
  89 lbx lb lb
  90 l l l.
  91 Interface       Attribute       Value
  92 T{
  93 .BR putenv ()
  94 T}      Thread safety   MT-Unsafe const:env
  95 .TE
  96 .hy
  97 .ad
  98 .sp 1
  99 .SH CONFORMING TO
 100 POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD.
 101 .SH NOTES
 102 The
 103 .BR putenv ()
 104 function is not required to be reentrant, and the
 105 one in glibc 2.0 is not, but the glibc 2.1 version is.
 106 .\" .LP
 107 .\" Description for libc4, libc5, glibc:
 108 .\" If the argument \fIstring\fP is of the form \fIname\fP,
 109 .\" and does not contain an \(aq=\(aq character, then the variable \fIname\fP
 110 .\" is removed from the environment.
 111 .\" If
 112 .\" .BR putenv ()
 113 .\" has to allocate a new array \fIenviron\fP,
 114 .\" and the previous array was also allocated by
 115 .\" .BR putenv (),
 116 .\" then it will be freed.
 117 .\" In no case will the old storage associated
 118 .\" to the environment variable itself be freed.
 119 .PP
 120 Since version 2.1.2, the glibc implementation conforms to SUSv2:
 121 the pointer \fIstring\fP given to
 122 .BR putenv ()
 123 is used.
 124 In particular, this string becomes part of the environment;
 125 changing it later will change the environment.
 126 (Thus, it is an error to call
 127 .BR putenv ()
 128 with an automatic variable
 129 as the argument, then return from the calling function while \fIstring\fP
 130 is still part of the environment.)
 131 However, glibc versions 2.0 to 2.1.1 differ: a copy of the string is used.
 132 On the one hand this causes a memory leak, and on the other hand
 133 it violates SUSv2.
 134 .PP
 135 The 4.4BSD version, like glibc 2.0, uses a copy.
 136 .PP
 137 SUSv2 removes the \fIconst\fP from the prototype, and so does glibc 2.1.3.
 138 .PP
 139 The GNU C library implementation provides a nonstandard extension.
 140 If
 141 .I string
 142 does not include an equal sign:
 143 .PP
 144 .in +4n
 145 .EX
 146 putenv("NAME");
 147 .EE
 148 .in
 149 .PP
 150 then the named variable is removed from the caller's environment.
 151 .SH SEE ALSO
 152 .BR clearenv (3),
 153 .BR getenv (3),
 154 .BR setenv (3),
 155 .BR unsetenv (3),
 156 .BR environ (7)