man3/setenv.3

   1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   2 .\" and Copyright (C) 2004, 2007 Michael Kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(VERBATIM)
   5 .\" Permission is granted to make and distribute verbatim copies of this
   6 .\" manual provided the copyright notice and this permission notice are
   7 .\" preserved on all copies.
   8 .\"
   9 .\" Permission is granted to copy and distribute modified versions of this
  10 .\" manual under the conditions for verbatim copying, provided that the
  11 .\" entire resulting derived work is distributed under the terms of a
  12 .\" permission notice identical to this one.
  13 .\"
  14 .\" Since the Linux kernel and libraries are constantly changing, this
  15 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  16 .\" responsibility for errors or omissions, or for damages resulting from
  17 .\" the use of the information contained herein.  The author(s) may not
  18 .\" have taken the same level of care in the production of this manual,
  19 .\" which is licensed free of charge, as they might when working
  20 .\" professionally.
  21 .\"
  22 .\" Formatted or processed versions of this manual, if unaccompanied by
  23 .\" the source, must acknowledge the copyright and authors of this work.
  24 .\" %%%LICENSE_END
  25 .\"
  26 .\" References consulted:
  27 .\"     Linux libc source code
  28 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  29 .\"     386BSD man pages
  30 .\" Modified Sat Jul 24 18:20:58 1993 by Rik Faith (faith@cs.unc.edu)
  31 .\" Modified Fri Feb 14 21:47:50 1997 by Andries Brouwer (aeb@cwi.nl)
  32 .\" Modified 9 Jun 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  33 .\"     Changed unsetenv() prototype; added EINVAL error
  34 .\"     Noted nonstandard behavior of setenv() if name contains '='
  35 .\" 2005-08-12, mtk, glibc 2.3.4 fixed the "name contains '='" bug
  36 .\"
  37 .TH SETENV 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  38 .SH NAME
  39 setenv \- change or add an environment variable
  40 .SH SYNOPSIS
  41 .nf
  42 .B #include <stdlib.h>
  43 .PP
  44 .BI "int setenv(const char *" name ", const char *" value ", int " overwrite );
  45 .BI "int unsetenv(const char *" name );
  46 .fi
  47 .PP
  48 .RS -4
  49 Feature Test Macro Requirements for glibc (see
  50 .BR feature_test_macros (7)):
  51 .RE
  52 .PP
  53 .BR setenv (),
  54 .BR unsetenv ():
  55 .nf
  56     _POSIX_C_SOURCE >= 200112L
  57         || /* Glibc <= 2.19: */ _BSD_SOURCE
  58 .fi
  59 .SH DESCRIPTION
  60 The
  61 .BR setenv ()
  62 function adds the variable
  63 .I name
  64 to the
  65 environment with the value
  66 .IR value ,
  67 if
  68 .I name
  69 does not
  70 already exist.
  71 If
  72 .I name
  73 does exist in the environment, then
  74 its value is changed to
  75 .IR value
  76 if
  77 .I overwrite
  78 is nonzero;
  79 if
  80 .IR overwrite
  81 is zero, then the value of
  82 .I name
  83 is not changed (and
  84 .BR setenv ()
  85 returns a success status).
  86 This function makes copies of the strings pointed to by
  87 .I name
  88 and
  89 .I value
  90 (by contrast with
  91 .BR putenv (3)).
  92 .PP
  93 The
  94 .BR unsetenv ()
  95 function deletes the variable
  96 .I name
  97 from
  98 the environment.
  99 If
 100 .I name
 101 does not exist in the environment,
 102 then the function succeeds, and the environment is unchanged.
 103 .SH RETURN VALUE
 104 .BR setenv ()
 105 and
 106 .BR unsetenv ()
 107 functions return zero on success,
 108 or \-1 on error, with
 109 .I errno
 110 set to indicate the error.
 111 .SH ERRORS
 112 .TP
 113 .B EINVAL
 114 .I name
 115 is NULL, points to a string of length 0,
 116 or contains an \(aq=\(aq character.
 117 .TP
 118 .B ENOMEM
 119 Insufficient memory to add a new variable to the environment.
 120 .SH ATTRIBUTES
 121 For an explanation of the terms used in this section, see
 122 .BR attributes (7).
 123 .ad l
 124 .nh
 125 .TS
 126 allbox;
 127 lbx lb lb
 128 l l l.
 129 Interface       Attribute       Value
 130 T{
 131 .BR setenv (),
 132 .BR unsetenv ()
 133 T}      Thread safety   MT-Unsafe const:env
 134 .TE
 135 .hy
 136 .ad
 137 .sp 1
 138 .SH CONFORMING TO
 139 POSIX.1-2001, POSIX.1-2008, 4.3BSD.
 140 .SH NOTES
 141 POSIX.1 does not require
 142 .BR setenv ()
 143 or
 144 .BR unsetenv ()
 145 to be reentrant.
 146 .PP
 147 Prior to glibc 2.2.2,
 148 .BR unsetenv ()
 149 was prototyped
 150 as returning
 151 .IR void ;
 152 more recent glibc versions follow the
 153 POSIX.1-compliant prototype shown in the SYNOPSIS.
 154 .SH BUGS
 155 POSIX.1 specifies that if
 156 .I name
 157 contains an \(aq=\(aq character, then
 158 .BR setenv ()
 159 should fail with the error
 160 .BR EINVAL ;
 161 however, versions of glibc before 2.3.4 allowed an \(aq=\(aq sign in
 162 .IR name .
 163 .SH SEE ALSO
 164 .BR clearenv (3),
 165 .BR getenv (3),
 166 .BR putenv (3),
 167 .BR environ (7)