diff options
| author | Glenn Morris | 2012-04-07 19:07:16 -0700 |
|---|---|---|
| committer | Glenn Morris | 2012-04-07 19:07:16 -0700 |
| commit | 8fc85b2054579f268077be7b44f4b4eb6a43963a (patch) | |
| tree | 76254c6e9d43fd80d05d943a039eef41de4a8516 | |
| parent | f48a9cb464ca8a7e9d5bdceb4a9de2ef036c70a7 (diff) | |
| download | emacs-8fc85b2054579f268077be7b44f4b4eb6a43963a.tar.gz emacs-8fc85b2054579f268077be7b44f4b4eb6a43963a.zip | |
Use @env for environment variables in texinfo manuals
It renders the same as @code, so in many cases this change is entirely cosmetic.
* doc/emacs/misc.texi (Gnus Startup):
* doc/lispref/files.texi, doc/lispref/frames.texi:
* doc/lispref/loading.texi, doc/lispref/os.texi, doc/lispref/processes.texi:
Use @env for environment variables.
| -rw-r--r-- | doc/emacs/ChangeLog | 4 | ||||
| -rw-r--r-- | doc/emacs/misc.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/lispref/files.texi | 10 | ||||
| -rw-r--r-- | doc/lispref/frames.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/loading.texi | 2 | ||||
| -rw-r--r-- | doc/lispref/os.texi | 26 | ||||
| -rw-r--r-- | doc/lispref/processes.texi | 6 |
8 files changed, 33 insertions, 24 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index dede6771fd9..848248963be 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog | |||
| @@ -1,3 +1,7 @@ | |||
| 1 | 2012-04-08 Glenn Morris <rgm@gnu.org> | ||
| 2 | |||
| 3 | * misc.texi (Gnus Startup): Use @env for environment variables. | ||
| 4 | |||
| 1 | 2012-04-07 Glenn Morris <rgm@gnu.org> | 5 | 2012-04-07 Glenn Morris <rgm@gnu.org> |
| 2 | 6 | ||
| 3 | * Makefile.in: Replace non-portable use of $< in ordinary rules. | 7 | * Makefile.in: Replace non-portable use of $< in ordinary rules. |
diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi index 84b9d6ee03b..ca9c2760ce2 100644 --- a/doc/emacs/misc.texi +++ b/doc/emacs/misc.texi | |||
| @@ -92,7 +92,7 @@ file named @file{.newsrc} in your home directory which lists your | |||
| 92 | Usenet newsgroups and subscriptions (this file is not unique to Gnus; | 92 | Usenet newsgroups and subscriptions (this file is not unique to Gnus; |
| 93 | it is used by many other newsreader programs). It then tries to | 93 | it is used by many other newsreader programs). It then tries to |
| 94 | contact the system's default news server, which is typically specified | 94 | contact the system's default news server, which is typically specified |
| 95 | by the @samp{NNTPSERVER} environment variable. | 95 | by the @env{NNTPSERVER} environment variable. |
| 96 | 96 | ||
| 97 | If your system does not have a default news server, or if you wish | 97 | If your system does not have a default news server, or if you wish |
| 98 | to use Gnus for reading email, then before invoking @kbd{M-x gnus} you | 98 | to use Gnus for reading email, then before invoking @kbd{M-x gnus} you |
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index ba87aa3c5d5..eb07b7c10ca 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,8 @@ | |||
| 1 | 2012-04-08 Glenn Morris <rgm@gnu.org> | ||
| 2 | |||
| 3 | * files.texi, frames.texi, loading.texi, os.texi, processes.texi: | ||
| 4 | Use @env for environment variables. | ||
| 5 | |||
| 1 | 2012-04-07 Glenn Morris <rgm@gnu.org> | 6 | 2012-04-07 Glenn Morris <rgm@gnu.org> |
| 2 | 7 | ||
| 3 | * Makefile.in: Replace non-portable use of $< in ordinary rules. | 8 | * Makefile.in: Replace non-portable use of $< in ordinary rules. |
diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index b49e56158ad..3e96a448963 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi | |||
| @@ -2154,7 +2154,7 @@ double all @samp{$} characters to prevent subsequent incorrect | |||
| 2154 | results. | 2154 | results. |
| 2155 | 2155 | ||
| 2156 | @c Wordy to avoid overfull hbox. --rjc 15mar92 | 2156 | @c Wordy to avoid overfull hbox. --rjc 15mar92 |
| 2157 | Here we assume that the environment variable @code{HOME}, which holds | 2157 | Here we assume that the environment variable @env{HOME}, which holds |
| 2158 | the user's home directory name, has value @samp{/xcssun/users/rms}. | 2158 | the user's home directory name, has value @samp{/xcssun/users/rms}. |
| 2159 | 2159 | ||
| 2160 | @example | 2160 | @example |
| @@ -2239,9 +2239,9 @@ non-@code{nil}. To use it, you should expand the prefix against | |||
| 2239 | the proper directory before calling @code{make-temp-file}. | 2239 | the proper directory before calling @code{make-temp-file}. |
| 2240 | 2240 | ||
| 2241 | @defopt temporary-file-directory | 2241 | @defopt temporary-file-directory |
| 2242 | @cindex @code{TMPDIR} environment variable | 2242 | @cindex @env{TMPDIR} environment variable |
| 2243 | @cindex @code{TMP} environment variable | 2243 | @cindex @env{TMP} environment variable |
| 2244 | @cindex @code{TEMP} environment variable | 2244 | @cindex @env{TEMP} environment variable |
| 2245 | This variable specifies the directory name for creating temporary files. | 2245 | This variable specifies the directory name for creating temporary files. |
| 2246 | Its value should be a directory name (@pxref{Directory Names}), but it | 2246 | Its value should be a directory name (@pxref{Directory Names}), but it |
| 2247 | is good for Lisp programs to cope if the value is a directory's file | 2247 | is good for Lisp programs to cope if the value is a directory's file |
| @@ -2249,7 +2249,7 @@ name instead. Using the value as the second argument to | |||
| 2249 | @code{expand-file-name} is a good way to achieve that. | 2249 | @code{expand-file-name} is a good way to achieve that. |
| 2250 | 2250 | ||
| 2251 | The default value is determined in a reasonable way for your operating | 2251 | The default value is determined in a reasonable way for your operating |
| 2252 | system; it is based on the @code{TMPDIR}, @code{TMP} and @code{TEMP} | 2252 | system; it is based on the @env{TMPDIR}, @env{TMP} and @env{TEMP} |
| 2253 | environment variables, with a fall-back to a system-dependent name if | 2253 | environment variables, with a fall-back to a system-dependent name if |
| 2254 | none of these variables is defined. | 2254 | none of these variables is defined. |
| 2255 | 2255 | ||
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index 125d6071cab..1bd4cf4854b 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi | |||
| @@ -488,7 +488,7 @@ frame. @code{title} and @code{name} are meaningful on all terminals. | |||
| 488 | @item display | 488 | @item display |
| 489 | The display on which to open this frame. It should be a string of the | 489 | The display on which to open this frame. It should be a string of the |
| 490 | form @code{"@var{host}:@var{dpy}.@var{screen}"}, just like the | 490 | form @code{"@var{host}:@var{dpy}.@var{screen}"}, just like the |
| 491 | @code{DISPLAY} environment variable. | 491 | @env{DISPLAY} environment variable. |
| 492 | 492 | ||
| 493 | @vindex display-type, a frame parameter | 493 | @vindex display-type, a frame parameter |
| 494 | @item display-type | 494 | @item display-type |
diff --git a/doc/lispref/loading.texi b/doc/lispref/loading.texi index 47a2a39ed63..7fc9535d88b 100644 --- a/doc/lispref/loading.texi +++ b/doc/lispref/loading.texi | |||
| @@ -235,7 +235,7 @@ it skips the latter group. | |||
| 235 | in a list of directories specified by the variable @code{load-path}. | 235 | in a list of directories specified by the variable @code{load-path}. |
| 236 | 236 | ||
| 237 | @defvar load-path | 237 | @defvar load-path |
| 238 | @cindex @code{EMACSLOADPATH} environment variable | 238 | @cindex @env{EMACSLOADPATH} environment variable |
| 239 | The value of this variable is a list of directories to search when | 239 | The value of this variable is a list of directories to search when |
| 240 | loading files with @code{load}. Each element is a string (which must be | 240 | loading files with @code{load}. Each element is a string (which must be |
| 241 | a directory name) or @code{nil} (which stands for the current working | 241 | a directory name) or @code{nil} (which stands for the current working |
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index 8a57ed2c1f0..649b93e6082 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi | |||
| @@ -89,7 +89,7 @@ that Emacs is being initialized. | |||
| 89 | @c set-locale-environment | 89 | @c set-locale-environment |
| 90 | @item | 90 | @item |
| 91 | It sets the language environment and the terminal coding system, | 91 | It sets the language environment and the terminal coding system, |
| 92 | if requested by environment variables such as @code{LANG}. | 92 | if requested by environment variables such as @env{LANG}. |
| 93 | 93 | ||
| 94 | @item | 94 | @item |
| 95 | It does some basic parsing of the command-line arguments. | 95 | It does some basic parsing of the command-line arguments. |
| @@ -352,8 +352,8 @@ control whether and where to find the init file; @samp{-q} (and the | |||
| 352 | stronger @samp{-Q}) says not to load an init file, while @samp{-u | 352 | stronger @samp{-Q}) says not to load an init file, while @samp{-u |
| 353 | @var{user}} says to load @var{user}'s init file instead of yours. | 353 | @var{user}} says to load @var{user}'s init file instead of yours. |
| 354 | @xref{Entering Emacs,,, emacs, The GNU Emacs Manual}. If neither | 354 | @xref{Entering Emacs,,, emacs, The GNU Emacs Manual}. If neither |
| 355 | option is specified, Emacs uses the @code{LOGNAME} environment | 355 | option is specified, Emacs uses the @env{LOGNAME} environment |
| 356 | variable, or the @code{USER} (most systems) or @code{USERNAME} (MS | 356 | variable, or the @env{USER} (most systems) or @env{USERNAME} (MS |
| 357 | systems) variable, to find your home directory and thus your init | 357 | systems) variable, to find your home directory and thus your init |
| 358 | file; this way, even if you have su'd, Emacs still loads your own init | 358 | file; this way, even if you have su'd, Emacs still loads your own init |
| 359 | file. If those environment variables are absent, though, Emacs uses | 359 | file. If those environment variables are absent, though, Emacs uses |
| @@ -430,7 +430,7 @@ This variable holds the name of the @file{.emacs.d} directory. It is | |||
| 430 | Each terminal type can have its own Lisp library that Emacs loads when | 430 | Each terminal type can have its own Lisp library that Emacs loads when |
| 431 | run on that type of terminal. The library's name is constructed by | 431 | run on that type of terminal. The library's name is constructed by |
| 432 | concatenating the value of the variable @code{term-file-prefix} and the | 432 | concatenating the value of the variable @code{term-file-prefix} and the |
| 433 | terminal type (specified by the environment variable @code{TERM}). | 433 | terminal type (specified by the environment variable @env{TERM}). |
| 434 | Normally, @code{term-file-prefix} has the value | 434 | Normally, @code{term-file-prefix} has the value |
| 435 | @code{"term/"}; changing this is not recommended. Emacs finds the file | 435 | @code{"term/"}; changing this is not recommended. Emacs finds the file |
| 436 | in the normal manner, by searching the @code{load-path} directories, and | 436 | in the normal manner, by searching the @code{load-path} directories, and |
| @@ -468,7 +468,7 @@ use this hook to define initializations for terminals that do not | |||
| 468 | have their own libraries. @xref{Hooks}. | 468 | have their own libraries. @xref{Hooks}. |
| 469 | 469 | ||
| 470 | @defvar term-file-prefix | 470 | @defvar term-file-prefix |
| 471 | @cindex @code{TERM} environment variable | 471 | @cindex @env{TERM} environment variable |
| 472 | If the value of this variable is non-@code{nil}, Emacs loads a | 472 | If the value of this variable is non-@code{nil}, Emacs loads a |
| 473 | terminal-specific initialization file as follows: | 473 | terminal-specific initialization file as follows: |
| 474 | 474 | ||
| @@ -481,7 +481,7 @@ You may set the @code{term-file-prefix} variable to @code{nil} in your | |||
| 481 | init file if you do not wish to load the | 481 | init file if you do not wish to load the |
| 482 | terminal-initialization file. | 482 | terminal-initialization file. |
| 483 | 483 | ||
| 484 | On MS-DOS, Emacs sets the @code{TERM} environment variable to @samp{internal}. | 484 | On MS-DOS, Emacs sets the @env{TERM} environment variable to @samp{internal}. |
| 485 | @end defvar | 485 | @end defvar |
| 486 | 486 | ||
| 487 | @defvar term-setup-hook | 487 | @defvar term-setup-hook |
| @@ -1010,7 +1010,7 @@ value is @code{":"} for Unix and GNU systems, and @code{";"} for MS systems. | |||
| 1010 | 1010 | ||
| 1011 | @defun parse-colon-path path | 1011 | @defun parse-colon-path path |
| 1012 | This function takes a search path string such as the value of | 1012 | This function takes a search path string such as the value of |
| 1013 | the @code{PATH} environment variable, and splits it at the separators, | 1013 | the @env{PATH} environment variable, and splits it at the separators, |
| 1014 | returning a list of directory names. @code{nil} in this list means | 1014 | returning a list of directory names. @code{nil} in this list means |
| 1015 | the current directory. Although the function's name says | 1015 | the current directory. Although the function's name says |
| 1016 | ``colon'', it actually uses the value of @code{path-separator}. | 1016 | ``colon'', it actually uses the value of @code{path-separator}. |
| @@ -1113,7 +1113,7 @@ want to use the default value. | |||
| 1113 | 1113 | ||
| 1114 | @defun user-login-name &optional uid | 1114 | @defun user-login-name &optional uid |
| 1115 | This function returns the name under which the user is logged in. | 1115 | This function returns the name under which the user is logged in. |
| 1116 | It uses the environment variables @code{LOGNAME} or @code{USER} if | 1116 | It uses the environment variables @env{LOGNAME} or @env{USER} if |
| 1117 | either is set. Otherwise, the value is based on the effective | 1117 | either is set. Otherwise, the value is based on the effective |
| 1118 | @acronym{UID}, not the real @acronym{UID}. | 1118 | @acronym{UID}, not the real @acronym{UID}. |
| 1119 | 1119 | ||
| @@ -1124,12 +1124,12 @@ corresponds to @var{uid}, or @code{nil} if there is no such user. | |||
| 1124 | @defun user-real-login-name | 1124 | @defun user-real-login-name |
| 1125 | This function returns the user name corresponding to Emacs's real | 1125 | This function returns the user name corresponding to Emacs's real |
| 1126 | @acronym{UID}. This ignores the effective @acronym{UID}, and the | 1126 | @acronym{UID}. This ignores the effective @acronym{UID}, and the |
| 1127 | environment variables @code{LOGNAME} and @code{USER}. | 1127 | environment variables @env{LOGNAME} and @env{USER}. |
| 1128 | @end defun | 1128 | @end defun |
| 1129 | 1129 | ||
| 1130 | @defun user-full-name &optional uid | 1130 | @defun user-full-name &optional uid |
| 1131 | This function returns the full name of the logged-in user---or the value | 1131 | This function returns the full name of the logged-in user---or the value |
| 1132 | of the environment variable @code{NAME}, if that is set. | 1132 | of the environment variable @env{NAME}, if that is set. |
| 1133 | 1133 | ||
| 1134 | If the Emacs process's user-id does not correspond to any known user (and | 1134 | If the Emacs process's user-id does not correspond to any known user (and |
| 1135 | provided @code{NAME} is not set), the result is @code{"unknown"}. | 1135 | provided @code{NAME} is not set), the result is @code{"unknown"}. |
| @@ -1249,9 +1249,9 @@ The argument @var{time-value}, if given, specifies a time (represented | |||
| 1249 | as a list of integers) to analyze instead of the current time. | 1249 | as a list of integers) to analyze instead of the current time. |
| 1250 | @end defun | 1250 | @end defun |
| 1251 | 1251 | ||
| 1252 | The current time zone is determined by the @samp{TZ} environment | 1252 | The current time zone is determined by the @env{TZ} environment |
| 1253 | variable. @xref{System Environment}. For example, you can tell Emacs | 1253 | variable. @xref{System Environment}. For example, you can tell Emacs |
| 1254 | to use universal time with @code{(setenv "TZ" "UTC0")}. If @samp{TZ} | 1254 | to use universal time with @code{(setenv "TZ" "UTC0")}. If @env{TZ} |
| 1255 | is not in the environment, Emacs uses a platform-dependent default | 1255 | is not in the environment, Emacs uses a platform-dependent default |
| 1256 | time zone. | 1256 | time zone. |
| 1257 | 1257 | ||
| @@ -1325,7 +1325,7 @@ yourself before you call @code{encode-time}. | |||
| 1325 | The optional argument @var{zone} defaults to the current time zone and | 1325 | The optional argument @var{zone} defaults to the current time zone and |
| 1326 | its daylight saving time rules. If specified, it can be either a list | 1326 | its daylight saving time rules. If specified, it can be either a list |
| 1327 | (as you would get from @code{current-time-zone}), a string as in the | 1327 | (as you would get from @code{current-time-zone}), a string as in the |
| 1328 | @code{TZ} environment variable, @code{t} for Universal Time, or an | 1328 | @env{TZ} environment variable, @code{t} for Universal Time, or an |
| 1329 | integer (as you would get from @code{decode-time}). The specified | 1329 | integer (as you would get from @code{decode-time}). The specified |
| 1330 | zone is used without any further alteration for daylight saving time. | 1330 | zone is used without any further alteration for daylight saving time. |
| 1331 | 1331 | ||
diff --git a/doc/lispref/processes.texi b/doc/lispref/processes.texi index 0dae20427c6..d251240d198 100644 --- a/doc/lispref/processes.texi +++ b/doc/lispref/processes.texi | |||
| @@ -77,14 +77,14 @@ sections. Since the three functions are all called in a similar | |||
| 77 | fashion, their common arguments are described here. | 77 | fashion, their common arguments are described here. |
| 78 | 78 | ||
| 79 | @cindex execute program | 79 | @cindex execute program |
| 80 | @cindex @code{PATH} environment variable | 80 | @cindex @env{PATH} environment variable |
| 81 | @cindex @code{HOME} environment variable | 81 | @cindex @env{HOME} environment variable |
| 82 | In all cases, the function's @var{program} argument specifies the | 82 | In all cases, the function's @var{program} argument specifies the |
| 83 | program to be run. An error is signaled if the file is not found or | 83 | program to be run. An error is signaled if the file is not found or |
| 84 | cannot be executed. If the file name is relative, the variable | 84 | cannot be executed. If the file name is relative, the variable |
| 85 | @code{exec-path} contains a list of directories to search. Emacs | 85 | @code{exec-path} contains a list of directories to search. Emacs |
| 86 | initializes @code{exec-path} when it starts up, based on the value of | 86 | initializes @code{exec-path} when it starts up, based on the value of |
| 87 | the environment variable @code{PATH}. The standard file name | 87 | the environment variable @env{PATH}. The standard file name |
| 88 | constructs, @samp{~}, @samp{.}, and @samp{..}, are interpreted as | 88 | constructs, @samp{~}, @samp{.}, and @samp{..}, are interpreted as |
| 89 | usual in @code{exec-path}, but environment variable substitutions | 89 | usual in @code{exec-path}, but environment variable substitutions |
| 90 | (@samp{$HOME}, etc.) are not recognized; use | 90 | (@samp{$HOME}, etc.) are not recognized; use |