aboutsummaryrefslogtreecommitdiffstats
path: root/lisp
diff options
context:
space:
mode:
authorKaroly Lorentey2005-12-29 04:57:14 +0000
committerKaroly Lorentey2005-12-29 04:57:14 +0000
commit17ccbd91f620a84e7524b99b74077b4ddb736283 (patch)
treec74a9173a86d8dfb3f227deca1c9fcdc1d867b5d /lisp
parent01999e9d53e4e8d12314b16ce7d0e3d7785bfbe3 (diff)
downloademacs-17ccbd91f620a84e7524b99b74077b4ddb736283.tar.gz
emacs-17ccbd91f620a84e7524b99b74077b4ddb736283.zip
Update environment-related doc strings.
* lisp/env.el (setenv, getenv): Update doc strings. * src/callproc.c (Fgetenv_internal, syms_of_callproc): Update doc strings. git-archimport-id: lorentey@elte.hu--2004/emacs--multi-tty--0--patch-470
Diffstat (limited to 'lisp')
-rw-r--r--lisp/env.el19
1 files changed, 10 insertions, 9 deletions
diff --git a/lisp/env.el b/lisp/env.el
index 38a9e865283..54bd0cdfb33 100644
--- a/lisp/env.el
+++ b/lisp/env.el
@@ -97,17 +97,18 @@ Use `$$' to insert a single dollar sign."
97(defun setenv (variable &optional value unset substitute-env-vars frame) 97(defun setenv (variable &optional value unset substitute-env-vars frame)
98 "Set the value of the environment variable named VARIABLE to VALUE. 98 "Set the value of the environment variable named VARIABLE to VALUE.
99VARIABLE should be a string. VALUE is optional; if not provided or 99VARIABLE should be a string. VALUE is optional; if not provided or
100nil, the environment variable VARIABLE will be removed. UNSET 100nil, the environment variable VARIABLE will be removed.
101if non-nil means to remove VARIABLE from the environment. 101UNSET if non-nil means to remove VARIABLE from the environment.
102SUBSTITUTE-ENV-VARS, if non-nil, means to substitute environment 102SUBSTITUTE-ENV-VARS, if non-nil, means to substitute environment
103variables in VALUE with `substitute-env-vars', where see. 103variables in VALUE with `substitute-env-vars', where see.
104Value is the new value if VARIABLE, or nil if removed from the 104Value is the new value if VARIABLE, or nil if removed from the
105environment. 105environment.
106 106
107Interactively, a prefix argument means to unset the variable. 107Interactively, a prefix argument means to unset the variable, and
108Interactively, the current value (if any) of the variable 108otherwise the current value (if any) of the variable appears at
109appears at the front of the history list when you type in the new value. 109the front of the history list when you type in the new value.
110Interactively, always replace environment variables in the new value. 110This function always replaces environment variables in the new
111value when called interactively.
111 112
112If VARIABLE is set in `process-environment', then this function 113If VARIABLE is set in `process-environment', then this function
113modifies its value there. Otherwise, this function works by 114modifies its value there. Otherwise, this function works by
@@ -212,11 +213,11 @@ VARIABLE should be a string. Value is nil if VARIABLE is undefined in
212the environment. Otherwise, value is a string. 213the environment. Otherwise, value is a string.
213 214
214If optional parameter FRAME is non-nil, then it should be a 215If optional parameter FRAME is non-nil, then it should be a
215frame. If the specified terminal device has its own set of 216frame. If that frame has its own set of environment variables,
216environment variables, this function will look up VARIABLE in it. 217this function will look up VARIABLE in there.
217 218
218Otherwise, this function searches `process-environment' for 219Otherwise, this function searches `process-environment' for
219VARIABLE. If it was not found there, then it continues the 220VARIABLE. If it is not found there, then it continues the
220search in either `global-environment' or the environment list of 221search in either `global-environment' or the environment list of
221the selected frame, depending on the value of 222the selected frame, depending on the value of
222`local-environment-variables'." 223`local-environment-variables'."