W3cubDocs

/Haskell 8

System.Posix.Env

Copyright (c) The University of Glasgow 2002
License BSD-style (see the file libraries/base/LICENSE)
Maintainer [email protected]
Stability provisional
Portability non-portable (requires POSIX)
Safe Haskell Safe
Language Haskell2010

Description

POSIX environment support

getEnv Source

Arguments

:: String

variable name

-> IO (Maybe String)

variable value

getEnv looks up a variable in the environment.

getEnvDefault Source

Arguments

:: String

variable name

-> String

fallback value

-> IO String

variable value or fallback value

getEnvDefault is a wrapper around getEnv where the programmer can specify a fallback if the variable is not found in the environment.

getEnvironmentPrim :: IO [String] Source

getEnvironment Source

Arguments

:: IO [(String, String)]
[(key,value)]

getEnvironment retrieves the entire environment as a list of (key,value) pairs.

setEnvironment Source

Arguments

:: [(String, String)]
[(key,value)]
-> IO ()

setEnvironment resets the entire environment to the given list of (key,value) pairs.

putEnv Source

Arguments

:: String

"key=value"

-> IO ()

putEnv function takes an argument of the form name=value and is equivalent to setEnv(key,value,True{-overwrite-}).

setEnv Source

Arguments

:: String

variable name

-> String

variable value

-> Bool

overwrite

-> IO ()

The setEnv function inserts or resets the environment variable name in the current environment list. If the variable name does not exist in the list, it is inserted with the given value. If the variable does exist, the argument overwrite is tested; if overwrite is False, the variable is not reset, otherwise it is reset to the given value.

unsetEnv Source

Arguments

:: String

variable name

-> IO ()

The unsetEnv function deletes all instances of the variable name from the environment.

clearEnv :: IO () Source

The clearEnv function clears the environment of all name-value pairs.

© The University of Glasgow and others
Licensed under a BSD-style license (see top of the page).
https://downloads.haskell.org/~ghc/8.6.1/docs/html/libraries/unix-2.7.2.2/System-Posix-Env.html