base-compat-0.12.1: A compatibility layer for base

Safe Haskell | Safe-Inferred
Language | Haskell2010

System.Environment.Compat

Description

Miscellaneous information about the system environment.

Synopsis

- getArgs :: IO [String]
- getProgName :: IO String
- getEnv :: String -> IO String
- lookupEnv :: String -> IO (Maybe String)
- setEnv :: String -> String -> IO ()
- unsetEnv :: String -> IO ()
- withArgs :: [String] -> IO a -> IO a
- withProgName :: String -> IO a -> IO a
- getEnvironment :: IO [(String, String)]

# Documentation

getArgs :: IO [String] #

Computation `getArgs` returns a list of the program's command line arguments (not including the program name).

getProgName :: IO String #

Computation `getProgName` returns the name of the program as it was invoked.

However, this is hard-to-impossible to implement on some non-Unix OSes, so instead, for maximum portability, we just return the leafname of the program as invoked. Even then there are some differences between platforms: on Windows, for example, a program invoked as foo is probably really `FOO.EXE`, and that is what `getProgName` will return.

getEnv :: String -> IO String #

Computation `getEnv` `var` returns the value of the environment variable `var`. For the inverse, the `setEnv` function can be used.

This computation may fail with:

- `isDoesNotExistError` if the environment variable does not exist.

lookupEnv :: String -> IO (Maybe String) #

Return the value of the environment variable `var`, or `Nothing` if there is no such value.

For POSIX users, this is equivalent to `getEnv`.

Since: base-4.6.0.0

setEnv :: String -> String -> IO () #

`setEnv name value` sets the specified environment variable to `value`.

Early versions of this function operated under the mistaken belief that setting an environment variable to the empty string on Windows removes that environment variable from the environment. For the sake of compatibility, it adopted that behavior on POSIX. In particular

    setEnv name ""

has the same effect as

    unsetEnv name

If you'd like to be able to set environment variables to blank strings, use `setEnv`.

Throws `IOException` if `name` is the empty string or contains an equals sign.

Since: base-4.7.0.0

unsetEnv :: String -> IO () #

`unsetEnv name` removes the specified environment variable from the environment of the current process.

Throws `IOException` if `name` is the empty string or contains an equals sign.

Since: base-4.7.0.0

withArgs :: [String] -> IO a -> IO a #

`withArgs` `args act` - while executing action `act`, have `getArgs` return `args`.

withProgName :: String -> IO a -> IO a #

`withProgName` `name act` - while executing action `act`, have `getProgName` return `name`.

getEnvironment :: IO [(String, String)] #

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

If an environment entry does not contain an `'='` character, the `key` is the whole entry and the `value` is the empty string.