mirror of
https://github.com/go-sylixos/elvish.git
synced 2024-12-04 02:37:50 +08:00
08007a52ce
For example, [`put`]() links to the elvdoc for "put". Also remove the @cf macro now that implicit targets make it easier to link to other elvdoc sections.
67 lines
1.6 KiB
Plaintext
67 lines
1.6 KiB
Plaintext
# Sets an environment variable to the given value. Calling `set-env VAR_NAME
|
|
# value` is similar to `set E:VAR_NAME = value`, but allows the variable name
|
|
# to be dynamic.
|
|
#
|
|
# Example:
|
|
#
|
|
# ```elvish-transcript
|
|
# ~> set-env X foobar
|
|
# ~> put $E:X
|
|
# ▶ foobar
|
|
# ```
|
|
#
|
|
# See also [`get-env`](), [`has-env`](), and [`unset-env`]().
|
|
fn set-env {|name value| }
|
|
|
|
# Unset an environment variable. Calling `unset-env VAR_NAME` is similar to
|
|
# `del E:VAR_NAME`, but allows the variable name to be dynamic.
|
|
#
|
|
# Example:
|
|
#
|
|
# ```elvish-transcript
|
|
# ~> set E:X = foo
|
|
# ~> unset-env X
|
|
# ~> has-env X
|
|
# ▶ $false
|
|
# ~> put $E:X
|
|
# ▶ ''
|
|
# ```
|
|
#
|
|
# See also [`has-env`](), [`get-env`](), and [`set-env`]().
|
|
fn unset-env {|name| }
|
|
|
|
# Test whether an environment variable exists. This command has no equivalent
|
|
# operation using the `E:` namespace (but see https://b.elv.sh/1026).
|
|
#
|
|
# Examples:
|
|
#
|
|
# ```elvish-transcript
|
|
# ~> has-env PATH
|
|
# ▶ $true
|
|
# ~> has-env NO_SUCH_ENV
|
|
# ▶ $false
|
|
# ```
|
|
#
|
|
# See also [`get-env`](), [`set-env`](), and [`unset-env`]().
|
|
fn has-env {|name| }
|
|
|
|
# Gets the value of an environment variable. Throws an exception if the
|
|
# environment variable does not exist.
|
|
#
|
|
# Calling `get-env VAR_NAME` is similar to `put $E:VAR_NAME`, but allows the
|
|
# variable name to be dynamic, and throws an exception instead of producing an
|
|
# empty string for nonexistent environment variables.
|
|
#
|
|
# Examples:
|
|
#
|
|
# ```elvish-transcript
|
|
# ~> get-env LANG
|
|
# ▶ zh_CN.UTF-8
|
|
# ~> get-env NO_SUCH_ENV
|
|
# Exception: non-existent environment variable
|
|
# [tty], line 1: get-env NO_SUCH_ENV
|
|
# ```
|
|
#
|
|
# See also [`has-env`](), [`set-env`](), and [`unset-env`]().
|
|
fn get-env {|name| }
|