diff options
| author | Karoly Lorentey | 2005-12-29 04:57:14 +0000 |
|---|---|---|
| committer | Karoly Lorentey | 2005-12-29 04:57:14 +0000 |
| commit | 17ccbd91f620a84e7524b99b74077b4ddb736283 (patch) | |
| tree | c74a9173a86d8dfb3f227deca1c9fcdc1d867b5d /lisp | |
| parent | 01999e9d53e4e8d12314b16ce7d0e3d7785bfbe3 (diff) | |
| download | emacs-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.el | 19 |
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. |
| 99 | VARIABLE should be a string. VALUE is optional; if not provided or | 99 | VARIABLE should be a string. VALUE is optional; if not provided or |
| 100 | nil, the environment variable VARIABLE will be removed. UNSET | 100 | nil, the environment variable VARIABLE will be removed. |
| 101 | if non-nil means to remove VARIABLE from the environment. | 101 | UNSET if non-nil means to remove VARIABLE from the environment. |
| 102 | SUBSTITUTE-ENV-VARS, if non-nil, means to substitute environment | 102 | SUBSTITUTE-ENV-VARS, if non-nil, means to substitute environment |
| 103 | variables in VALUE with `substitute-env-vars', where see. | 103 | variables in VALUE with `substitute-env-vars', where see. |
| 104 | Value is the new value if VARIABLE, or nil if removed from the | 104 | Value is the new value if VARIABLE, or nil if removed from the |
| 105 | environment. | 105 | environment. |
| 106 | 106 | ||
| 107 | Interactively, a prefix argument means to unset the variable. | 107 | Interactively, a prefix argument means to unset the variable, and |
| 108 | Interactively, the current value (if any) of the variable | 108 | otherwise the current value (if any) of the variable appears at |
| 109 | appears at the front of the history list when you type in the new value. | 109 | the front of the history list when you type in the new value. |
| 110 | Interactively, always replace environment variables in the new value. | 110 | This function always replaces environment variables in the new |
| 111 | value when called interactively. | ||
| 111 | 112 | ||
| 112 | If VARIABLE is set in `process-environment', then this function | 113 | If VARIABLE is set in `process-environment', then this function |
| 113 | modifies its value there. Otherwise, this function works by | 114 | modifies 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 | |||
| 212 | the environment. Otherwise, value is a string. | 213 | the environment. Otherwise, value is a string. |
| 213 | 214 | ||
| 214 | If optional parameter FRAME is non-nil, then it should be a | 215 | If optional parameter FRAME is non-nil, then it should be a |
| 215 | frame. If the specified terminal device has its own set of | 216 | frame. If that frame has its own set of environment variables, |
| 216 | environment variables, this function will look up VARIABLE in it. | 217 | this function will look up VARIABLE in there. |
| 217 | 218 | ||
| 218 | Otherwise, this function searches `process-environment' for | 219 | Otherwise, this function searches `process-environment' for |
| 219 | VARIABLE. If it was not found there, then it continues the | 220 | VARIABLE. If it is not found there, then it continues the |
| 220 | search in either `global-environment' or the environment list of | 221 | search in either `global-environment' or the environment list of |
| 221 | the selected frame, depending on the value of | 222 | the selected frame, depending on the value of |
| 222 | `local-environment-variables'." | 223 | `local-environment-variables'." |