diff options
| author | Chong Yidong | 2012-01-14 17:17:25 +0800 |
|---|---|---|
| committer | Chong Yidong | 2012-01-14 17:17:25 +0800 |
| commit | a73a3461db808a5b616aa0a654d9e9b6d2fd18d3 (patch) | |
| tree | fabb1e608a3193847d8e1a7a79c6fd0d211ae3bf /doc | |
| parent | 9e5788aaef98e88aeb5b2476549f72b591e0bf4a (diff) | |
| download | emacs-a73a3461db808a5b616aa0a654d9e9b6d2fd18d3.tar.gz emacs-a73a3461db808a5b616aa0a654d9e9b6d2fd18d3.zip | |
Update Emacs Invocation chapter of Emacs manual.
* doc/emacs/cmdargs.texi (Action Arguments): No need to mention
EMACSLOADPATH.
(General Variables): Add xref to Lisp Libraries.
(Initial Options): Copyedits.
(Resume Arguments): Node deleted; emacs.bash/csh are obsolete.
(Environment): Clarify what getenv does.
(General Variables): Clarify EMACSPATH etc. Emacs does not assume
light backgrounds on xterms.
(Misc Variables): TEMP and TMP are not Windows-specific.
(Display X): Copyedits.
(Colors X): -bd does nothing for GTK.
(Icons X): Gnome 3 doesn't use taskbars.
* doc/emacs/misc.texi (Shell): Document exec-path here.
* doc/emacs/rmail.texi (Movemail): Add xref for exec-path.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/emacs/ChangeLog | 19 | ||||
| -rw-r--r-- | doc/emacs/cmdargs.texi | 226 | ||||
| -rw-r--r-- | doc/emacs/emacs.texi | 1 | ||||
| -rw-r--r-- | doc/emacs/files.texi | 7 | ||||
| -rw-r--r-- | doc/emacs/misc.texi | 16 | ||||
| -rw-r--r-- | doc/emacs/rmail.texi | 4 |
6 files changed, 129 insertions, 144 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index 8f7f8ebb220..ab8c822ffcf 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog | |||
| @@ -1,3 +1,22 @@ | |||
| 1 | 2012-01-14 Chong Yidong <cyd@gnu.org> | ||
| 2 | |||
| 3 | * cmdargs.texi (Action Arguments): No need to mention | ||
| 4 | EMACSLOADPATH. | ||
| 5 | (General Variables): Add xref to Lisp Libraries. | ||
| 6 | (Initial Options): Copyedits. | ||
| 7 | (Resume Arguments): Node deleted; emacs.bash/csh are obsolete. | ||
| 8 | (Environment): Clarify what getenv does. | ||
| 9 | (General Variables): Clarify EMACSPATH etc. Emacs does not assume | ||
| 10 | light backgrounds on xterms. | ||
| 11 | (Misc Variables): TEMP and TMP are not Windows-specific. | ||
| 12 | (Display X): Copyedits. | ||
| 13 | (Colors X): -bd does nothing for GTK. | ||
| 14 | (Icons X): Gnome 3 doesn't use taskbars. | ||
| 15 | |||
| 16 | * misc.texi (Shell): Document exec-path here. | ||
| 17 | |||
| 18 | * rmail.texi (Movemail): Add xref for exec-path. | ||
| 19 | |||
| 1 | 2012-01-13 Glenn Morris <rgm@gnu.org> | 20 | 2012-01-13 Glenn Morris <rgm@gnu.org> |
| 2 | 21 | ||
| 3 | * dired.texi (Dired and Find): Clarify find-ls-options. | 22 | * dired.texi (Dired and Find): Clarify find-ls-options. |
diff --git a/doc/emacs/cmdargs.texi b/doc/emacs/cmdargs.texi index 11cc4df8ce9..00730cc6510 100644 --- a/doc/emacs/cmdargs.texi +++ b/doc/emacs/cmdargs.texi | |||
| @@ -65,7 +65,6 @@ arguments.) | |||
| 65 | and call functions. | 65 | and call functions. |
| 66 | * Initial Options:: Arguments that take effect while starting Emacs. | 66 | * Initial Options:: Arguments that take effect while starting Emacs. |
| 67 | * Command Example:: Examples of using command line arguments. | 67 | * Command Example:: Examples of using command line arguments. |
| 68 | * Resume Arguments:: Specifying arguments when you resume a running Emacs. | ||
| 69 | * Environment:: Environment variables that Emacs uses. | 68 | * Environment:: Environment variables that Emacs uses. |
| 70 | * Display X:: Changing the default display and using remote login. | 69 | * Display X:: Changing the default display and using remote login. |
| 71 | * Font X:: Choosing a font for text, under X. | 70 | * Font X:: Choosing a font for text, under X. |
| @@ -124,10 +123,9 @@ Visit @var{file} using @code{find-file}, then go to line number | |||
| 124 | @opindex --load | 123 | @opindex --load |
| 125 | @cindex loading Lisp libraries, command-line argument | 124 | @cindex loading Lisp libraries, command-line argument |
| 126 | Load a Lisp library named @var{file} with the function @code{load}. | 125 | Load a Lisp library named @var{file} with the function @code{load}. |
| 127 | @xref{Lisp Libraries}. If @var{file} is not an absolute file name, | 126 | If @var{file} is not an absolute file name, Emacs first looks for it |
| 128 | the library can be found either in the current directory, or in the | 127 | in the current directory, then in the directories listed in |
| 129 | Emacs library search path as specified with @env{EMACSLOADPATH} | 128 | @code{load-path} (@pxref{Lisp Libraries}). |
| 130 | (@pxref{General Variables}). | ||
| 131 | 129 | ||
| 132 | @strong{Warning:} If previous command-line arguments have visited | 130 | @strong{Warning:} If previous command-line arguments have visited |
| 133 | files, the current directory is the directory of the last file | 131 | files, the current directory is the directory of the last file |
| @@ -186,11 +184,11 @@ specifically related to the X Window System appear in the following | |||
| 186 | sections. | 184 | sections. |
| 187 | 185 | ||
| 188 | Some initial options affect the loading of the initialization file. | 186 | Some initial options affect the loading of the initialization file. |
| 189 | The normal actions of Emacs are to first load @file{site-start.el} if | 187 | Normally, Emacs first loads @file{site-start.el} if it exists, then |
| 190 | it exists, then your own initialization file @file{~/.emacs} if it | 188 | your own initialization file if it exists, and finally the default |
| 191 | exists, and finally @file{default.el} if it exists. @xref{Init File}. | 189 | initialization file @file{default.el} if it exists (@pxref{Init |
| 192 | Certain options prevent loading of some of these files or substitute | 190 | File}). Certain options prevent loading of some of these files or |
| 193 | other files for them. | 191 | substitute other files for them. |
| 194 | 192 | ||
| 195 | @table @samp | 193 | @table @samp |
| 196 | @item -chdir @var{directory} | 194 | @item -chdir @var{directory} |
| @@ -207,8 +205,8 @@ stopped. This makes desktop saving and restoring easier. | |||
| 207 | @itemx --terminal=@var{device} | 205 | @itemx --terminal=@var{device} |
| 208 | @opindex --terminal | 206 | @opindex --terminal |
| 209 | @cindex device for Emacs terminal I/O | 207 | @cindex device for Emacs terminal I/O |
| 210 | Use @var{device} as the device for terminal input and output. | 208 | Use @var{device} as the device for terminal input and output. This |
| 211 | @samp{--terminal} implies @samp{--no-window-system}. | 209 | option implies @samp{--no-window-system}. |
| 212 | 210 | ||
| 213 | @item -d @var{display} | 211 | @item -d @var{display} |
| 214 | @opindex -d | 212 | @opindex -d |
| @@ -252,7 +250,7 @@ terminal's standard input stream (@code{stdin}) instead. | |||
| 252 | @samp{--batch} implies @samp{-q} (do not load an initialization file), | 250 | @samp{--batch} implies @samp{-q} (do not load an initialization file), |
| 253 | but @file{site-start.el} is loaded nonetheless. It also causes Emacs | 251 | but @file{site-start.el} is loaded nonetheless. It also causes Emacs |
| 254 | to exit after processing all the command options. In addition, it | 252 | to exit after processing all the command options. In addition, it |
| 255 | disables auto-saving except in buffers for which it has been | 253 | disables auto-saving except in buffers for which auto-saving is |
| 256 | explicitly requested. | 254 | explicitly requested. |
| 257 | 255 | ||
| 258 | @item --script @var{file} | 256 | @item --script @var{file} |
| @@ -270,8 +268,8 @@ Emacs. They can start with this text on the first line | |||
| 270 | 268 | ||
| 271 | @noindent | 269 | @noindent |
| 272 | which will invoke Emacs with @samp{--script} and supply the name of | 270 | which will invoke Emacs with @samp{--script} and supply the name of |
| 273 | the script file as @var{file}. Emacs Lisp then treats @samp{#!} as a | 271 | the script file as @var{file}. Emacs Lisp then treats the @samp{#!} |
| 274 | comment delimiter. | 272 | on this first line as a comment delimiter. |
| 275 | 273 | ||
| 276 | @item -q | 274 | @item -q |
| 277 | @opindex -q | 275 | @opindex -q |
| @@ -280,11 +278,10 @@ comment delimiter. | |||
| 280 | @cindex bypassing init and @file{default.el} file | 278 | @cindex bypassing init and @file{default.el} file |
| 281 | @cindex init file, not loading | 279 | @cindex init file, not loading |
| 282 | @cindex @file{default.el} file, not loading | 280 | @cindex @file{default.el} file, not loading |
| 283 | Do not load your Emacs initialization file, and do not load the file | 281 | Do not load any initialization file (@pxref{Init File}). When Emacs |
| 284 | @file{default.el} either (@pxref{Init File}). Regardless of this | 282 | is invoked with this option, the Customize facility does not allow |
| 285 | switch, @file{site-start.el} is still loaded. When Emacs is invoked | 283 | options to be saved (@pxref{Easy Customization}). This option does |
| 286 | like this, the Customize facility does not allow options to be saved | 284 | not disable loading @file{site-start.el}. |
| 287 | (@pxref{Easy Customization}). | ||
| 288 | 285 | ||
| 289 | @item --no-site-file | 286 | @item --no-site-file |
| 290 | @opindex --no-site-file | 287 | @opindex --no-site-file |
| @@ -371,45 +368,6 @@ also guarantees there will be no problem redirecting output to | |||
| 371 | @file{log}, because Emacs will not assume that it has a display terminal | 368 | @file{log}, because Emacs will not assume that it has a display terminal |
| 372 | to work with. | 369 | to work with. |
| 373 | 370 | ||
| 374 | @node Resume Arguments | ||
| 375 | @appendixsec Resuming Emacs with Arguments | ||
| 376 | |||
| 377 | You can specify action arguments for Emacs when you resume it after | ||
| 378 | a suspension. To prepare for this, put the following code in your | ||
| 379 | @file{.emacs} file (@pxref{Hooks}): | ||
| 380 | |||
| 381 | @c `resume-suspend-hook' is correct. It is the name of a function. | ||
| 382 | @example | ||
| 383 | (add-hook 'suspend-hook 'resume-suspend-hook) | ||
| 384 | (add-hook 'suspend-resume-hook 'resume-process-args) | ||
| 385 | @end example | ||
| 386 | |||
| 387 | As further preparation, you must execute the shell script | ||
| 388 | @file{emacs.csh} (if you use csh as your shell) or @file{emacs.bash} | ||
| 389 | (if you use bash as your shell). These scripts define an alias named | ||
| 390 | @code{edit}, which will resume Emacs giving it new command line | ||
| 391 | arguments such as files to visit. The scripts are found in the | ||
| 392 | @file{etc} subdirectory of the Emacs distribution. | ||
| 393 | |||
| 394 | Only action arguments work properly when you resume Emacs. Initial | ||
| 395 | arguments are not recognized---it's too late to execute them anyway. | ||
| 396 | |||
| 397 | Note that resuming Emacs (with or without arguments) must be done from | ||
| 398 | within the shell that is the parent of the Emacs job. This is why | ||
| 399 | @code{edit} is an alias rather than a program or a shell script. It is | ||
| 400 | not possible to implement a resumption command that could be run from | ||
| 401 | other subjobs of the shell; there is no way to define a command that could | ||
| 402 | be made the value of @env{EDITOR}, for example. Therefore, this feature | ||
| 403 | does not take the place of the Emacs Server feature (@pxref{Emacs | ||
| 404 | Server}). | ||
| 405 | |||
| 406 | The aliases use the Emacs Server feature if you appear to have a | ||
| 407 | server Emacs running. However, they cannot determine this with complete | ||
| 408 | accuracy. They may think that a server is still running when in | ||
| 409 | actuality you have killed that Emacs, because the file | ||
| 410 | @file{/tmp/esrv@dots{}} still exists. If this happens, find that | ||
| 411 | file and delete it. | ||
| 412 | |||
| 413 | @node Environment | 371 | @node Environment |
| 414 | @appendixsec Environment Variables | 372 | @appendixsec Environment Variables |
| 415 | @cindex environment variables | 373 | @cindex environment variables |
| @@ -424,19 +382,19 @@ letters only. The values are all text strings. | |||
| 424 | environment automatically from their parent process. This means you | 382 | environment automatically from their parent process. This means you |
| 425 | can set up an environment variable in your login shell, and all the | 383 | can set up an environment variable in your login shell, and all the |
| 426 | programs you run (including Emacs) will automatically see it. | 384 | programs you run (including Emacs) will automatically see it. |
| 427 | Subprocesses of Emacs (such as shells, compilers, and version-control | 385 | Subprocesses of Emacs (such as shells, compilers, and version control |
| 428 | software) inherit the environment from Emacs, too. | 386 | programs) inherit the environment from Emacs, too. |
| 429 | 387 | ||
| 430 | @findex setenv | 388 | @findex setenv |
| 431 | @findex getenv | 389 | @findex getenv |
| 432 | @vindex initial-environment | 390 | @vindex initial-environment |
| 433 | Inside Emacs, the command @kbd{M-x getenv} gets the value of an | 391 | Inside Emacs, the command @kbd{M-x getenv} reads the name of an |
| 434 | environment variable. @kbd{M-x setenv} sets a variable in the Emacs | 392 | environment variable, and prints its value in the echo area. @kbd{M-x |
| 435 | environment, and @kbd{C-u M-x setenv} removes a variable. | 393 | setenv} sets a variable in the Emacs environment, and @kbd{C-u M-x |
| 436 | (Environment variable substitutions with @samp{$} work in the value | 394 | setenv} removes a variable. (Environment variable substitutions with |
| 437 | just as in file names; see @ref{File Names with $}.) The variable | 395 | @samp{$} work in the value just as in file names; see @ref{File Names |
| 438 | @code{initial-environment} stores the initial environment inherited by | 396 | with $}.) The variable @code{initial-environment} stores the initial |
| 439 | Emacs. | 397 | environment inherited by Emacs. |
| 440 | 398 | ||
| 441 | The way to set environment variables outside of Emacs depends on the | 399 | The way to set environment variables outside of Emacs depends on the |
| 442 | operating system, and especially the shell that you are using. For | 400 | operating system, and especially the shell that you are using. For |
| @@ -483,22 +441,25 @@ This is used to initialize the Lisp variable @code{data-directory}. | |||
| 483 | Directory for the documentation string file, which is used to | 441 | Directory for the documentation string file, which is used to |
| 484 | initialize the Lisp variable @code{doc-directory}. | 442 | initialize the Lisp variable @code{doc-directory}. |
| 485 | @item EMACSLOADPATH | 443 | @item EMACSLOADPATH |
| 486 | A colon-separated list of directories@footnote{ | 444 | A colon-separated list of directories@footnote{ Here and below, |
| 487 | Here and below, whenever we say ``colon-separated list of directories,'' | 445 | whenever we say ``colon-separated list of directories,'' it pertains |
| 488 | it pertains to Unix and GNU/Linux systems. On MS-DOS and MS-Windows, | 446 | to Unix and GNU/Linux systems. On MS-DOS and MS-Windows, the |
| 489 | the directories are separated by semi-colons instead, since DOS/Windows | 447 | directories are separated by semi-colons instead, since DOS/Windows |
| 490 | file names might include a colon after a drive letter.} | 448 | file names might include a colon after a drive letter.} to search for |
| 491 | to search for Emacs Lisp files---used to initialize @code{load-path}. | 449 | Emacs Lisp files. If set, it overrides the usual initial value of the |
| 450 | @code{load-path} variable (@pxref{Lisp Libraries}). | ||
| 492 | @item EMACSPATH | 451 | @item EMACSPATH |
| 493 | A colon-separated list of directories to search for executable | 452 | A colon-separated list of directories to search for executable files. |
| 494 | files---used to initialize @code{exec-path}. | 453 | If set, Emacs uses this in addition to @env{PATH} (see below) when |
| 454 | initializing the variable @code{exec-path} (@pxref{Shell}). | ||
| 495 | @item EMAIL | 455 | @item EMAIL |
| 496 | @vindex user-mail-address@r{, initialization} | 456 | @vindex user-mail-address@r{, initialization} |
| 497 | Your email address; used to initialize the Lisp variable | 457 | Your email address; used to initialize the Lisp variable |
| 498 | @code{user-mail-address}, which the Emacs mail interface puts into | 458 | @code{user-mail-address}, which the Emacs mail interface puts into the |
| 499 | the @samp{From} header of outgoing messages (@pxref{Mail Headers}). | 459 | @samp{From} header of outgoing messages (@pxref{Mail Headers}). |
| 500 | @item ESHELL | 460 | @item ESHELL |
| 501 | Used for shell-mode to override the @env{SHELL} environment variable. | 461 | Used for shell-mode to override the @env{SHELL} environment variable |
| 462 | (@pxref{Interactive Shell}). | ||
| 502 | @item HISTFILE | 463 | @item HISTFILE |
| 503 | The name of the file that shell commands are saved in between logins. | 464 | The name of the file that shell commands are saved in between logins. |
| 504 | This variable defaults to @file{~/.bash_history} if you use Bash, to | 465 | This variable defaults to @file{~/.bash_history} if you use Bash, to |
| @@ -554,23 +515,28 @@ environment and coding system. @xref{Language Environments}. | |||
| 554 | The user's login name. See also @env{USER}. | 515 | The user's login name. See also @env{USER}. |
| 555 | @item MAIL | 516 | @item MAIL |
| 556 | The name of your system mail inbox. | 517 | The name of your system mail inbox. |
| 518 | @ifnottex | ||
| 557 | @item MH | 519 | @item MH |
| 558 | Name of setup file for the mh system. (The default is @file{~/.mh_profile}.) | 520 | Name of setup file for the mh system. @xref{Top,,MH-E,mh-e, The Emacs |
| 521 | Interface to MH}. | ||
| 522 | @end ifnottex | ||
| 559 | @item NAME | 523 | @item NAME |
| 560 | Your real-world name. | 524 | Your real-world name. This is used to initialize the variable |
| 525 | @code{user-full-name} (@pxref{Mail Headers}). | ||
| 561 | @item NNTPSERVER | 526 | @item NNTPSERVER |
| 562 | The name of the news server. Used by the mh and Gnus packages. | 527 | The name of the news server. Used by the mh and Gnus packages. |
| 563 | @item ORGANIZATION | 528 | @item ORGANIZATION |
| 564 | The name of the organization to which you belong. Used for setting the | 529 | The name of the organization to which you belong. Used for setting the |
| 565 | `Organization:' header in your posts from the Gnus package. | 530 | `Organization:' header in your posts from the Gnus package. |
| 566 | @item PATH | 531 | @item PATH |
| 567 | A colon-separated list of directories in which executables reside. This | 532 | A colon-separated list of directories containing executable files. |
| 568 | is used to initialize the Emacs Lisp variable @code{exec-path}. | 533 | This is used to initialize the variable @code{exec-path} |
| 534 | (@pxref{Shell}). | ||
| 569 | @item PWD | 535 | @item PWD |
| 570 | If set, this should be the default directory when Emacs was started. | 536 | If set, this should be the default directory when Emacs was started. |
| 571 | @item REPLYTO | 537 | @item REPLYTO |
| 572 | If set, this specifies an initial value for the variable | 538 | If set, this specifies an initial value for the variable |
| 573 | @code{mail-default-reply-to}. @xref{Mail Headers}. | 539 | @code{mail-default-reply-to} (@pxref{Mail Headers}). |
| 574 | @item SAVEDIR | 540 | @item SAVEDIR |
| 575 | The name of a directory in which news articles are saved by default. | 541 | The name of a directory in which news articles are saved by default. |
| 576 | Used by the Gnus package. | 542 | Used by the Gnus package. |
| @@ -578,23 +544,29 @@ Used by the Gnus package. | |||
| 578 | The name of an interpreter used to parse and execute programs run from | 544 | The name of an interpreter used to parse and execute programs run from |
| 579 | inside Emacs. | 545 | inside Emacs. |
| 580 | @item SMTPSERVER | 546 | @item SMTPSERVER |
| 581 | The name of the outgoing mail server. Used by the SMTP library | 547 | The name of the outgoing mail server. This is used to initialize the |
| 582 | (@pxref{Top,,,smtpmail,Sending mail via SMTP}). | 548 | variable @code{smtpmail-smtp-server} (@pxref{Mail Sending}). |
| 583 | @cindex background mode, on @command{xterm} | 549 | @cindex background mode, on @command{xterm} |
| 584 | @item TERM | 550 | @item TERM |
| 585 | The type of the terminal that Emacs is using. This variable must be | 551 | The type of the terminal that Emacs is using. This variable must be |
| 586 | set unless Emacs is run in batch mode. On MS-DOS, it defaults to | 552 | set unless Emacs is run in batch mode. On MS-DOS, it defaults to |
| 587 | @samp{internal}, which specifies a built-in terminal emulation that | 553 | @samp{internal}, which specifies a built-in terminal emulation that |
| 588 | handles the machine's own display. If the value of @env{TERM} indicates | 554 | handles the machine's own display. |
| 589 | that Emacs runs in non-windowed mode from @command{xterm} or a similar | ||
| 590 | terminal emulator, the background mode defaults to @samp{light}, and | ||
| 591 | Emacs will choose colors that are appropriate for a light background. | ||
| 592 | @item TERMCAP | 555 | @item TERMCAP |
| 593 | The name of the termcap library file describing how to program the | 556 | The name of the termcap library file describing how to program the |
| 594 | terminal specified by the @env{TERM} variable. This defaults to | 557 | terminal specified by @env{TERM}. This defaults to |
| 595 | @file{/etc/termcap}. | 558 | @file{/etc/termcap}. |
| 596 | @item TMPDIR | 559 | @item TMPDIR |
| 597 | Used by the Emerge package as a prefix for temporary files. | 560 | @itemx TMP |
| 561 | @itemx TEMP | ||
| 562 | These environment variables are used to initialize the variable | ||
| 563 | @code{temporary-file-directory}, which specifies a directory in which | ||
| 564 | to put temporary files (@pxref{Backup}). Emacs tries to use | ||
| 565 | @env{TMPDIR} first; if that is unset, it tries @env{TMP}, then | ||
| 566 | @env{TEMP}, and finally @file{/tmp}. But on MS-Windows and MS-DOS, | ||
| 567 | Emacs tries @env{TEMP}, then @env{TMPDIR}, then @env{TMP}, and finally | ||
| 568 | @file{c:/temp}. | ||
| 569 | |||
| 598 | @item TZ | 570 | @item TZ |
| 599 | This specifies the current time zone and possibly also daylight | 571 | This specifies the current time zone and possibly also daylight |
| 600 | saving time information. On MS-DOS, if @env{TZ} is not set in the | 572 | saving time information. On MS-DOS, if @env{TZ} is not set in the |
| @@ -624,11 +596,6 @@ variable. | |||
| 624 | On MS-DOS, this variable defaults to the value of the @env{USER} | 596 | On MS-DOS, this variable defaults to the value of the @env{USER} |
| 625 | variable. | 597 | variable. |
| 626 | 598 | ||
| 627 | @item TEMP | ||
| 628 | @itemx TMP | ||
| 629 | On MS-DOS and MS-Windows, these specify the name of the directory for | ||
| 630 | storing temporary files in. | ||
| 631 | |||
| 632 | @item EMACSTEST | 599 | @item EMACSTEST |
| 633 | On MS-DOS, this specifies a file to use to log the operation of the | 600 | On MS-DOS, this specifies a file to use to log the operation of the |
| 634 | internal terminal emulator. This feature is useful for submitting bug | 601 | internal terminal emulator. This feature is useful for submitting bug |
| @@ -710,27 +677,21 @@ of the settings which on X belong in the @file{.Xdefaults} file | |||
| 710 | @cindex display name (X Window System) | 677 | @cindex display name (X Window System) |
| 711 | @cindex @env{DISPLAY} environment variable | 678 | @cindex @env{DISPLAY} environment variable |
| 712 | 679 | ||
| 713 | The environment variable @env{DISPLAY} tells all X clients, including | 680 | The environment variable @env{DISPLAY} tells all X clients, |
| 714 | Emacs, where to display their windows. Its value is set by default | 681 | including Emacs, where to display their windows. Its value is set by |
| 715 | in ordinary circumstances, when you start an X server and run jobs | 682 | default in ordinary circumstances, when you start an X server and run |
| 716 | locally. Occasionally you may need to specify the display yourself; for | 683 | jobs locally. You can specify the display yourself; one reason to do |
| 717 | example, if you do a remote login and want to run a client program | 684 | this is if you want to log into another system and run Emacs there, |
| 718 | remotely, displaying on your local screen. | 685 | and have the window displayed at your local terminal. |
| 719 | |||
| 720 | With Emacs, the main reason people change the default display is to | ||
| 721 | let them log into another system, run Emacs on that system, but have the | ||
| 722 | window displayed at their local terminal. You might need to log in | ||
| 723 | to another system because the files you want to edit are there, or | ||
| 724 | because the Emacs executable file you want to run is there. | ||
| 725 | 686 | ||
| 726 | @env{DISPLAY} has the syntax | 687 | @env{DISPLAY} has the syntax |
| 727 | @samp{@var{host}:@var{display}.@var{screen}}, where @var{host} is the | 688 | @samp{@var{host}:@var{display}.@var{screen}}, where @var{host} is the |
| 728 | host name of the X Window System server machine, @var{display} is an | 689 | host name of the X Window System server machine, @var{display} is an |
| 729 | arbitrarily-assigned number that distinguishes your server (X | 690 | arbitrarily-assigned number that distinguishes your server (X |
| 730 | terminal) from other servers on the same machine, and @var{screen} is | 691 | terminal) from other servers on the same machine, and @var{screen} is |
| 731 | a rarely-used field that allows an X server to control multiple | 692 | a field that allows an X server to control multiple terminal screens. |
| 732 | terminal screens. The period and the @var{screen} field are optional. | 693 | The period and the @var{screen} field are optional. If included, |
| 733 | If included, @var{screen} is usually zero. | 694 | @var{screen} is usually zero. |
| 734 | 695 | ||
| 735 | For example, if your host is named @samp{glasperle} and your server is | 696 | For example, if your host is named @samp{glasperle} and your server is |
| 736 | the first (or perhaps the only) server listed in the configuration, your | 697 | the first (or perhaps the only) server listed in the configuration, your |
| @@ -744,9 +705,9 @@ by changing the @env{DISPLAY} variable, or with the option @samp{-d | |||
| 744 | emacs --display=glasperle:0 & | 705 | emacs --display=glasperle:0 & |
| 745 | @end smallexample | 706 | @end smallexample |
| 746 | 707 | ||
| 747 | You can inhibit the direct use of the window system and GUI with the | 708 | You can inhibit the use of the X window system with the @samp{-nw} |
| 748 | @samp{-nw} option. It tells Emacs to display using ordinary @acronym{ASCII} on | 709 | option. Then Emacs uses its controlling text terminal for display. |
| 749 | its controlling terminal. This is also an initial option. | 710 | @xref{Initial Options}. |
| 750 | 711 | ||
| 751 | Sometimes, security arrangements prevent a program on a remote system | 712 | Sometimes, security arrangements prevent a program on a remote system |
| 752 | from displaying on your local system. In this case, trying to run Emacs | 713 | from displaying on your local system. In this case, trying to run Emacs |
| @@ -778,17 +739,17 @@ font: | |||
| 778 | Use @var{font} as the default font. | 739 | Use @var{font} as the default font. |
| 779 | @end table | 740 | @end table |
| 780 | 741 | ||
| 781 | When passing a font specification to Emacs on the command line, you | 742 | When passing a font name to Emacs on the command line, you may need to |
| 782 | may need to ``quote'' it, by enclosing it in quotation marks, if it | 743 | ``quote'' it, by enclosing it in quotation marks, if it contains |
| 783 | contains characters that the shell treats specially (e.g.@: spaces). | 744 | characters that the shell treats specially (e.g.@: spaces). For |
| 784 | For example: | 745 | example: |
| 785 | 746 | ||
| 786 | @smallexample | 747 | @smallexample |
| 787 | emacs -fn "DejaVu Sans Mono-12" | 748 | emacs -fn "DejaVu Sans Mono-12" |
| 788 | @end smallexample | 749 | @end smallexample |
| 789 | 750 | ||
| 790 | @xref{Fonts}, for other ways to specify the default font and font name | 751 | @xref{Fonts}, for details about font names and other ways to specify |
| 791 | formats. | 752 | the default font. |
| 792 | 753 | ||
| 793 | @node Colors X | 754 | @node Colors X |
| 794 | @appendixsec Window Color Options | 755 | @appendixsec Window Color Options |
| @@ -819,7 +780,8 @@ Specify the background color, overriding the color specified by the | |||
| 819 | @itemx --border-color=@var{color} | 780 | @itemx --border-color=@var{color} |
| 820 | @opindex --border-color | 781 | @opindex --border-color |
| 821 | @cindex border color, command-line argument | 782 | @cindex border color, command-line argument |
| 822 | Specify the color of the border of the X window. | 783 | Specify the color of the border of the X window. This has no effect |
| 784 | if Emacs is compiled with GTK+ support. | ||
| 823 | @item -cr @var{color} | 785 | @item -cr @var{color} |
| 824 | @opindex -cr | 786 | @opindex -cr |
| 825 | @itemx --cursor-color=@var{color} | 787 | @itemx --cursor-color=@var{color} |
| @@ -844,11 +806,10 @@ Reverse video---swap the foreground and background colors. | |||
| 844 | @opindex --color | 806 | @opindex --color |
| 845 | @cindex standard colors on a character terminal | 807 | @cindex standard colors on a character terminal |
| 846 | @cindex override character terminal color support | 808 | @cindex override character terminal color support |
| 847 | For a character terminal only, specify the mode of color support. | 809 | Set the @dfn{color support mode} when Emacs is run on a text terminal. |
| 848 | This option is intended for overriding the number of supported colors | 810 | This option overrides the number of supported colors that the |
| 849 | that the character terminal advertises in its @code{termcap} or | 811 | character terminal advertises in its @code{termcap} or @code{terminfo} |
| 850 | @code{terminfo} database. The parameter @var{mode} can be one of the | 812 | database. The parameter @var{mode} can be one of the following: |
| 851 | following: | ||
| 852 | @table @samp | 813 | @table @samp |
| 853 | @item never | 814 | @item never |
| 854 | @itemx no | 815 | @itemx no |
| @@ -1090,7 +1051,7 @@ Start Emacs in an iconified (``minimized'') state. | |||
| 1090 | @itemx --no-bitmap-icon | 1051 | @itemx --no-bitmap-icon |
| 1091 | @opindex --no-bitmap-icon | 1052 | @opindex --no-bitmap-icon |
| 1092 | @cindex Emacs icon, a gnu | 1053 | @cindex Emacs icon, a gnu |
| 1093 | Do not display the Emacs icon. | 1054 | Disable the use of the Emacs icon. |
| 1094 | @end table | 1055 | @end table |
| 1095 | 1056 | ||
| 1096 | Most window managers allow you to ``iconify'' (or ``minimize'') an | 1057 | Most window managers allow you to ``iconify'' (or ``minimize'') an |
| @@ -1102,10 +1063,11 @@ The text frame doesn't appear until you deiconify (or ``un-minimize'') | |||
| 1102 | it. | 1063 | it. |
| 1103 | 1064 | ||
| 1104 | By default, Emacs uses an icon containing the Emacs logo. On | 1065 | By default, Emacs uses an icon containing the Emacs logo. On |
| 1105 | desktop environments such as Gnome, this icon is also displayed on the | 1066 | desktop environments such as Gnome, this icon is also displayed in |
| 1106 | ``taskbar''. The @samp{-nbi} or @samp{--no-bitmap-icon} option tells | 1067 | other contexts, e.g.@: when switching into an Emacs frame. The |
| 1107 | Emacs to let the window manager choose what sort of icon to | 1068 | @samp{-nbi} or @samp{--no-bitmap-icon} option tells Emacs to let the |
| 1108 | use---usually just a small rectangle containing the frame's title. | 1069 | window manager choose what sort of icon to use---usually just a small |
| 1070 | rectangle containing the frame's title. | ||
| 1109 | 1071 | ||
| 1110 | @node Misc X | 1072 | @node Misc X |
| 1111 | @appendixsec Other Display Options | 1073 | @appendixsec Other Display Options |
diff --git a/doc/emacs/emacs.texi b/doc/emacs/emacs.texi index b8722e9f850..b00625facbf 100644 --- a/doc/emacs/emacs.texi +++ b/doc/emacs/emacs.texi | |||
| @@ -1104,7 +1104,6 @@ Command Line Arguments for Emacs Invocation | |||
| 1104 | and call functions. | 1104 | and call functions. |
| 1105 | * Initial Options:: Arguments that take effect while starting Emacs. | 1105 | * Initial Options:: Arguments that take effect while starting Emacs. |
| 1106 | * Command Example:: Examples of using command line arguments. | 1106 | * Command Example:: Examples of using command line arguments. |
| 1107 | * Resume Arguments:: Specifying arguments when you resume a running Emacs. | ||
| 1108 | * Environment:: Environment variables that Emacs uses. | 1107 | * Environment:: Environment variables that Emacs uses. |
| 1109 | * Display X:: Changing the default display and using remote login. | 1108 | * Display X:: Changing the default display and using remote login. |
| 1110 | * Font X:: Choosing a font for text, under X. | 1109 | * Font X:: Choosing a font for text, under X. |
diff --git a/doc/emacs/files.texi b/doc/emacs/files.texi index a522e055d2b..77211a3d9ac 100644 --- a/doc/emacs/files.texi +++ b/doc/emacs/files.texi | |||
| @@ -1871,10 +1871,9 @@ Add each file name in @var{directory} and all of its nested | |||
| 1871 | subdirectories to the file name cache, using @command{locate} to find | 1871 | subdirectories to the file name cache, using @command{locate} to find |
| 1872 | them all. | 1872 | them all. |
| 1873 | @item M-x file-cache-add-directory-list @key{RET} @var{variable} @key{RET} | 1873 | @item M-x file-cache-add-directory-list @key{RET} @var{variable} @key{RET} |
| 1874 | Add each file name in each directory listed in @var{variable} | 1874 | Add each file name in each directory listed in @var{variable} to the |
| 1875 | to the file name cache. @var{variable} should be a Lisp variable | 1875 | file name cache. @var{variable} should be a Lisp variable whose value |
| 1876 | such as @code{load-path} or @code{exec-path}, whose value is a list | 1876 | is a list of directory names, like @code{load-path}. |
| 1877 | of directory names. | ||
| 1878 | @item M-x file-cache-clear-cache @key{RET} | 1877 | @item M-x file-cache-clear-cache @key{RET} |
| 1879 | Clear the cache; that is, remove all file names from it. | 1878 | Clear the cache; that is, remove all file names from it. |
| 1880 | @end table | 1879 | @end table |
diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi index 69e141efb0f..93dd5e3b8ce 100644 --- a/doc/emacs/misc.texi +++ b/doc/emacs/misc.texi | |||
| @@ -465,6 +465,15 @@ then give commands interactively. Full terminal emulation is | |||
| 465 | available. | 465 | available. |
| 466 | @end table | 466 | @end table |
| 467 | 467 | ||
| 468 | @vindex exec-path | ||
| 469 | Whenever you specify a relative file name for an executable program | ||
| 470 | (either in the @var{cmd} argument to one of the above commands, or in | ||
| 471 | other contexts), Emacs searches for the program in the directories | ||
| 472 | specified by the variable @code{exec-path}. The value of this | ||
| 473 | variable must be a list of directory names; the default value is | ||
| 474 | initialized from the environment variable @env{PATH} when Emacs is | ||
| 475 | started (@pxref{General Variables}). | ||
| 476 | |||
| 468 | @kbd{M-x eshell} invokes a shell implemented entirely in Emacs. It | 477 | @kbd{M-x eshell} invokes a shell implemented entirely in Emacs. It |
| 469 | is documented in its own manual. | 478 | is documented in its own manual. |
| 470 | @ifnottex | 479 | @ifnottex |
| @@ -551,11 +560,8 @@ to @command{gpg}. This will output the list of keys to the | |||
| 551 | The above commands use the shell specified by the variable | 560 | The above commands use the shell specified by the variable |
| 552 | @code{shell-file-name}. Its default value is determined by the | 561 | @code{shell-file-name}. Its default value is determined by the |
| 553 | @env{SHELL} environment variable when Emacs is started. If the file | 562 | @env{SHELL} environment variable when Emacs is started. If the file |
| 554 | name is relative, Emacs searches the directories in the list | 563 | name is relative, Emacs searches the directories listed in |
| 555 | @code{exec-path}; this list is initialized based on the environment | 564 | @code{exec-path} (@pxref{Shell}). |
| 556 | variable @env{PATH} when Emacs is started. Your init file can | ||
| 557 | override either or both of these default initializations (@pxref{Init | ||
| 558 | File}). | ||
| 559 | 565 | ||
| 560 | To specify a coding system for @kbd{M-!} or @kbd{M-|}, use the command | 566 | To specify a coding system for @kbd{M-!} or @kbd{M-|}, use the command |
| 561 | @kbd{C-x @key{RET} c} immediately beforehand. @xref{Communication Coding}. | 567 | @kbd{C-x @key{RET} c} immediately beforehand. @xref{Communication Coding}. |
diff --git a/doc/emacs/rmail.texi b/doc/emacs/rmail.texi index 9713b825ee8..be1c1f68c66 100644 --- a/doc/emacs/rmail.texi +++ b/doc/emacs/rmail.texi | |||
| @@ -1428,8 +1428,8 @@ This is equivalent to specifying the @samp{file} protocol: | |||
| 1428 | @code{movemail} to use. If that is a string, it specifies the | 1428 | @code{movemail} to use. If that is a string, it specifies the |
| 1429 | absolute file name of the @code{movemail} executable. If it is | 1429 | absolute file name of the @code{movemail} executable. If it is |
| 1430 | @code{nil}, Rmail searches for @code{movemail} in the directories | 1430 | @code{nil}, Rmail searches for @code{movemail} in the directories |
| 1431 | listed in @code{rmail-movemail-search-path} and @code{exec-path}, then | 1431 | listed in @code{rmail-movemail-search-path}, then in @code{exec-path} |
| 1432 | in @code{exec-directory}. | 1432 | (@pxref{Shell}), then in @code{exec-directory}. |
| 1433 | 1433 | ||
| 1434 | @node Remote Mailboxes | 1434 | @node Remote Mailboxes |
| 1435 | @section Retrieving Mail from Remote Mailboxes | 1435 | @section Retrieving Mail from Remote Mailboxes |