xref: /original-bsd/lib/libc/stdlib/getenv.3 (revision 82ca1924)
Copyright (c) 1988 The Regents of the University of California.
All rights reserved.

Redistribution and use in source and binary forms are permitted
provided that the above copyright notice and this paragraph are
duplicated in all such forms and that any documentation,
advertising materials, and other materials related to such
distribution and use acknowledge that the software was developed
by the University of California, Berkeley. The name of the
University may not be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

@(#)getenv.3 6.7 (Berkeley) 02/14/89

GETENV 3 ""
.AT 3
NAME
getenv, putenv, setenv, unsetenv - manipulate environmental variables
SYNOPSIS
 char *getenv(name)  char *name; 

setenv(name, value, overwrite) char *name, value; int overwrite;

putenv(string) char *string;

void unsetenv(name) char *name;

DESCRIPTION
Getenv searches the environment list (see environ(7)) for a string of the form name=value and returns a pointer to the string value if such a string is present, and 0 (NULL) if it is not.

Setenv searches the environment list as getenv does; if the string name is not found, a string of the form name=value is added to the environment. If it is found, and overwrite is non-zero, its value is changed to value. Setenv returns 0 on success and -1 on failure, where failure is caused by an inability to allocate space for the environment.

Putenv is provided for compatibility with System V. It takes an argument of the form ``name=value'' and is the equivalent of calling setenv(name, value, 1).

Unsetenv removes all occurrences of the string name from the environment. There is no library provision for completely removing the current environment. It is suggested that the following code be used to do so.

 static char *envinit[1];
 extern char **environ;
 environ = envinit;

All of these routines permit, but do not require, a trailing equals (``='') sign on name or a leading equals sign on value.

SEE ALSO
csh(1), sh(1), execve(2), environ(7)
BUGS
All information is part of the environment, so it must be copied if it is to be manipulated.