diff options
| author | Chong Yidong | 2011-08-28 14:49:59 -0400 |
|---|---|---|
| committer | Chong Yidong | 2011-08-28 14:49:59 -0400 |
| commit | ddb54206dd7aa4f461f59fe98b982691e1432a61 (patch) | |
| tree | 7ed2547c308b04caa9febfb817b0207b968b545f /doc | |
| parent | 7a1ff57fac7cba948020a7360eb630475945cbf8 (diff) | |
| download | emacs-ddb54206dd7aa4f461f59fe98b982691e1432a61.tar.gz emacs-ddb54206dd7aa4f461f59fe98b982691e1432a61.zip | |
Update manuals for some Emacs 24 changes.
* doc/emacs/misc.texi (emacsclient Options): Document server-port.
* doc/lispref/display.texi (Progress): Document spinner functionality.
* doc/lispref/frames.texi (Layout Parameters): The defaults for the
menu-bar-lines and tool-bar-lines parameters depend on the mode.
* doc/lispref/objects.texi (Symbol Type): Document ## print representation.
* doc/lispref/os.texi (Killing Emacs): Note that kill-emacs can be called by
operating system signals. Refer to save-buffers-kill-terminal
instead of save-buffers-kill-emacs.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/emacs/ChangeLog | 4 | ||||
| -rw-r--r-- | doc/emacs/emacs.texi | 6 | ||||
| -rw-r--r-- | doc/emacs/misc.texi | 5 | ||||
| -rw-r--r-- | doc/lispref/ChangeLog | 13 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 55 | ||||
| -rw-r--r-- | doc/lispref/frames.texi | 17 | ||||
| -rw-r--r-- | doc/lispref/objects.texi | 10 | ||||
| -rw-r--r-- | doc/lispref/os.texi | 68 |
8 files changed, 111 insertions, 67 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index 50eb89fe488..b3330022cb3 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog | |||
| @@ -1,3 +1,7 @@ | |||
| 1 | 2011-08-28 Chong Yidong <cyd@stupidchicken.com> | ||
| 2 | |||
| 3 | * misc.texi (emacsclient Options): Document server-port. | ||
| 4 | |||
| 1 | 2011-08-27 Eli Zaretskii <eliz@gnu.org> | 5 | 2011-08-27 Eli Zaretskii <eliz@gnu.org> |
| 2 | 6 | ||
| 3 | * frames.texi (Frame Commands): Advise setting focus-follows-mouse | 7 | * frames.texi (Frame Commands): Advise setting focus-follows-mouse |
diff --git a/doc/emacs/emacs.texi b/doc/emacs/emacs.texi index 060f939fa7a..5f0d66b95a3 100644 --- a/doc/emacs/emacs.texi +++ b/doc/emacs/emacs.texi | |||
| @@ -1054,6 +1054,12 @@ Hyperlinking and Navigation Features | |||
| 1054 | * Goto Address mode:: Activating URLs. | 1054 | * Goto Address mode:: Activating URLs. |
| 1055 | * FFAP:: Finding files etc. at point. | 1055 | * FFAP:: Finding files etc. at point. |
| 1056 | 1056 | ||
| 1057 | Emacs Lisp Packages | ||
| 1058 | |||
| 1059 | * Package Menu:: Buffer for viewing and managing packages. | ||
| 1060 | * Package Installation:: Options for package installation. | ||
| 1061 | * Package Files:: Where packages are installed. | ||
| 1062 | |||
| 1057 | Customization | 1063 | Customization |
| 1058 | 1064 | ||
| 1059 | * Easy Customization:: Convenient way to browse and change settings. | 1065 | * Easy Customization:: Convenient way to browse and change settings. |
diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi index 2dab70c512a..598f495784f 100644 --- a/doc/emacs/misc.texi +++ b/doc/emacs/misc.texi | |||
| @@ -1596,6 +1596,11 @@ runs, and (ii) provide @command{emacsclient} with the server file. | |||
| 1596 | (One convenient way to do the latter is to put the server file on a | 1596 | (One convenient way to do the latter is to put the server file on a |
| 1597 | networked file system such as NFS.) | 1597 | networked file system such as NFS.) |
| 1598 | 1598 | ||
| 1599 | @vindex server-port | ||
| 1600 | When the Emacs server is using TCP, the variable @code{server-port} | ||
| 1601 | determines the port number to listen on; the default value, | ||
| 1602 | @code{nil}, means to choose a random port when the server starts. | ||
| 1603 | |||
| 1599 | @item -n | 1604 | @item -n |
| 1600 | @itemx --no-wait | 1605 | @itemx --no-wait |
| 1601 | Let @command{emacsclient} exit immediately, instead of waiting until | 1606 | Let @command{emacsclient} exit immediately, instead of waiting until |
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index ca9c93b563d..2d46ad3f774 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,16 @@ | |||
| 1 | 2011-08-28 Chong Yidong <cyd@stupidchicken.com> | ||
| 2 | |||
| 3 | * frames.texi (Layout Parameters): The defaults for the | ||
| 4 | menu-bar-lines and tool-bar-lines parameters depend on the mode. | ||
| 5 | |||
| 6 | * display.texi (Progress): Document spinner functionality. | ||
| 7 | |||
| 8 | * os.texi (Killing Emacs): Note that kill-emacs can be called by | ||
| 9 | operating system signals. Refer to save-buffers-kill-terminal | ||
| 10 | instead of save-buffers-kill-emacs. | ||
| 11 | |||
| 12 | * objects.texi (Symbol Type): Document ## print representation. | ||
| 13 | |||
| 1 | 2011-08-25 Eli Zaretskii <eliz@gnu.org> | 14 | 2011-08-25 Eli Zaretskii <eliz@gnu.org> |
| 2 | 15 | ||
| 3 | * display.texi (Specified Space): Mention that `space' specs | 16 | * display.texi (Specified Space): Mention that `space' specs |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index bf7cd126a26..cfe4b8298fb 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -367,10 +367,9 @@ echo area, or @code{nil} if there is none. | |||
| 367 | When an operation can take a while to finish, you should inform the | 367 | When an operation can take a while to finish, you should inform the |
| 368 | user about the progress it makes. This way the user can estimate | 368 | user about the progress it makes. This way the user can estimate |
| 369 | remaining time and clearly see that Emacs is busy working, not hung. | 369 | remaining time and clearly see that Emacs is busy working, not hung. |
| 370 | A convenient way to do this is to use a @dfn{progress reporter}. | ||
| 370 | 371 | ||
| 371 | Functions listed in this section provide simple and efficient way of | 372 | Here is a working example that does nothing useful: |
| 372 | reporting operation progress. Here is a working example that does | ||
| 373 | nothing useful: | ||
| 374 | 373 | ||
| 375 | @smallexample | 374 | @smallexample |
| 376 | (let ((progress-reporter | 375 | (let ((progress-reporter |
| @@ -382,11 +381,11 @@ nothing useful: | |||
| 382 | (progress-reporter-done progress-reporter)) | 381 | (progress-reporter-done progress-reporter)) |
| 383 | @end smallexample | 382 | @end smallexample |
| 384 | 383 | ||
| 385 | @defun make-progress-reporter message min-value max-value &optional current-value min-change min-time | 384 | @defun make-progress-reporter message &optional min-value max-value current-value min-change min-time |
| 386 | This function creates and returns a @dfn{progress reporter}---an | 385 | This function creates and returns a progress reporter object, which |
| 387 | object you will use as an argument for all other functions listed | 386 | you will use as an argument for the other functions listed below. The |
| 388 | here. The idea is to precompute as much data as possible to make | 387 | idea is to precompute as much data as possible to make progress |
| 389 | progress reporting very fast. | 388 | reporting very fast. |
| 390 | 389 | ||
| 391 | When this progress reporter is subsequently used, it will display | 390 | When this progress reporter is subsequently used, it will display |
| 392 | @var{message} in the echo area, followed by progress percentage. | 391 | @var{message} in the echo area, followed by progress percentage. |
| @@ -394,24 +393,28 @@ When this progress reporter is subsequently used, it will display | |||
| 394 | on a filename, for instance, use @code{format} before calling this | 393 | on a filename, for instance, use @code{format} before calling this |
| 395 | function. | 394 | function. |
| 396 | 395 | ||
| 397 | @var{min-value} and @var{max-value} arguments stand for starting and | 396 | The arguments @var{min-value} and @var{max-value} should be numbers |
| 398 | final states of your operation. For instance, if you scan a buffer, | 397 | standing for the starting and final states of the operation. For |
| 399 | they should be the results of @code{point-min} and @code{point-max} | 398 | instance, an operation that ``scans'' a buffer should set these to the |
| 400 | correspondingly. It is required that @var{max-value} is greater than | 399 | results of @code{point-min} and @code{point-max} correspondingly. |
| 401 | @var{min-value}. If you create progress reporter when some part of | 400 | @var{max-value} should be greater than @var{min-value}. |
| 402 | the operation has already been completed, then specify | 401 | |
| 403 | @var{current-value} argument. But normally you should omit it or set | 402 | Alternatively, you can set @var{min-value} and @var{max-value} to |
| 404 | it to @code{nil}---it will default to @var{min-value} then. | 403 | @code{nil}. In that case, the progress reporter does not report |
| 405 | 404 | process percentages; it instead displays a ``spinner'' that rotates a | |
| 406 | Remaining arguments control the rate of echo area updates. Progress | 405 | notch each time you update the progress reporter. |
| 407 | reporter will wait for at least @var{min-change} more percents of the | 406 | |
| 408 | operation to be completed before printing next message. | 407 | If @var{min-value} and @var{max-value} are numbers, you can give the |
| 409 | @var{min-time} specifies the minimum time in seconds to pass between | 408 | argument @var{current-value} a numerical value specifying the initial |
| 410 | successive prints. It can be fractional. Depending on Emacs and | 409 | progress; if omitted, this defaults to @var{min-value}. |
| 411 | system capabilities, progress reporter may or may not respect this | 410 | |
| 412 | last argument or do it with varying precision. Default value for | 411 | The remaining arguments control the rate of echo area updates. The |
| 413 | @var{min-change} is 1 (one percent), for @var{min-time}---0.2 | 412 | progress reporter will wait for at least @var{min-change} more |
| 414 | (seconds.) | 413 | percents of the operation to be completed before printing next |
| 414 | message; the default is one percent. @var{min-time} specifies the | ||
| 415 | minimum time in seconds to pass between successive prints; the default | ||
| 416 | is 0.2 seconds. (On some operating systems, the progress reporter may | ||
| 417 | handle fractions of seconds with varying precision). | ||
| 415 | 418 | ||
| 416 | This function calls @code{progress-reporter-update}, so the first | 419 | This function calls @code{progress-reporter-update}, so the first |
| 417 | message is printed immediately. | 420 | message is printed immediately. |
diff --git a/doc/lispref/frames.texi b/doc/lispref/frames.texi index b6012a4dd53..e799cfa6b7f 100644 --- a/doc/lispref/frames.texi +++ b/doc/lispref/frames.texi | |||
| @@ -695,20 +695,19 @@ right fringe. However, you can force one fringe or the other to a | |||
| 695 | precise width by specifying that width as a negative integer. If both | 695 | precise width by specifying that width as a negative integer. If both |
| 696 | widths are negative, only the left fringe gets the specified width. | 696 | widths are negative, only the left fringe gets the specified width. |
| 697 | 697 | ||
| 698 | @vindex menu-bar-lines, a frame parameter | 698 | @vindex menu-bar-lines frame parameter |
| 699 | @item menu-bar-lines | 699 | @item menu-bar-lines |
| 700 | The number of lines to allocate at the top of the frame for a menu | 700 | The number of lines to allocate at the top of the frame for a menu |
| 701 | bar. The default is 1. A value of @code{nil} means don't display a | 701 | bar. The default is 1 if Menu Bar mode is enabled, and 0 otherwise. |
| 702 | menu bar. @xref{Menu Bar}. (The X toolkit and GTK allow at most one | 702 | @xref{Menu Bars,,,emacs, The GNU Emacs Manual}. |
| 703 | menu bar line; they treat larger values as 1.) | ||
| 704 | 703 | ||
| 705 | @vindex tool-bar-lines, a frame parameter | 704 | @vindex tool-bar-lines frame parameter |
| 706 | @item tool-bar-lines | 705 | @item tool-bar-lines |
| 707 | The number of lines to use for the tool bar. A value of @code{nil} | 706 | The number of lines to use for the tool bar. The default is 1 if Tool |
| 708 | means don't display a tool bar. (GTK and Nextstep allow at most one | 707 | Bar mode is enabled, and 0 otherwise. @xref{Tool Bars,,,emacs, The |
| 709 | tool bar line; they treat larger values as 1.) | 708 | GNU Emacs Manual}. |
| 710 | 709 | ||
| 711 | @vindex tool-bar-position, a frame parameter | 710 | @vindex tool-bar-position frame parameter |
| 712 | @item tool-bar-position | 711 | @item tool-bar-position |
| 713 | The position of the tool bar. Currently only for the GTK tool bar. | 712 | The position of the tool bar. Currently only for the GTK tool bar. |
| 714 | Value can be one of @code{top}, @code{bottom} @code{left}, @code{right}. | 713 | Value can be one of @code{top}, @code{bottom} @code{left}, @code{right}. |
diff --git a/doc/lispref/objects.texi b/doc/lispref/objects.texi index 6d63bb7b750..26def7858b7 100644 --- a/doc/lispref/objects.texi +++ b/doc/lispref/objects.texi | |||
| @@ -597,6 +597,7 @@ FOO ; @r{A symbol named @samp{FOO}, different from @samp{foo}.} | |||
| 597 | @end group | 597 | @end group |
| 598 | @end example | 598 | @end example |
| 599 | 599 | ||
| 600 | @cindex @samp{##} read syntax | ||
| 600 | @ifinfo | 601 | @ifinfo |
| 601 | @c This uses ``colon'' instead of a literal `:' because Info cannot | 602 | @c This uses ``colon'' instead of a literal `:' because Info cannot |
| 602 | @c cope with a `:' in a menu | 603 | @c cope with a `:' in a menu |
| @@ -605,9 +606,12 @@ FOO ; @r{A symbol named @samp{FOO}, different from @samp{foo}.} | |||
| 605 | @ifnotinfo | 606 | @ifnotinfo |
| 606 | @cindex @samp{#:} read syntax | 607 | @cindex @samp{#:} read syntax |
| 607 | @end ifnotinfo | 608 | @end ifnotinfo |
| 608 | Normally the Lisp reader interns all symbols (@pxref{Creating | 609 | As an exception to the rule that a symbol's name serves as its |
| 609 | Symbols}). To prevent interning, you can write @samp{#:} before the | 610 | printed representation, @samp{##} is the printed representation for an |
| 610 | name of the symbol. | 611 | interned symbol whose name is an empty string. Furthermore, |
| 612 | @samp{#:@var{foo}} is the printed representation for an uninterned | ||
| 613 | symbol whose name is @var{foo}. (Normally, the Lisp reader interns | ||
| 614 | all symbols; @pxref{Creating Symbols}.) | ||
| 611 | 615 | ||
| 612 | @node Sequence Type | 616 | @node Sequence Type |
| 613 | @subsection Sequence Types | 617 | @subsection Sequence Types |
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi index 8533b77b219..7d05f8f3468 100644 --- a/doc/lispref/os.texi +++ b/doc/lispref/os.texi | |||
| @@ -544,10 +544,11 @@ parent process normally resumes control. The low-level primitive for | |||
| 544 | killing Emacs is @code{kill-emacs}. | 544 | killing Emacs is @code{kill-emacs}. |
| 545 | 545 | ||
| 546 | @deffn Command kill-emacs &optional exit-data | 546 | @deffn Command kill-emacs &optional exit-data |
| 547 | This command exits the Emacs process and kills it. | 547 | This command calls the hook @code{kill-emacs-hook}, then exits the |
| 548 | Emacs process and kills it. | ||
| 548 | 549 | ||
| 549 | If @var{exit-data} is an integer, then it is used as the exit status | 550 | If @var{exit-data} is an integer, that is used as the exit status of |
| 550 | of the Emacs process. (This is useful primarily in batch operation; see | 551 | the Emacs process. (This is useful primarily in batch operation; see |
| 551 | @ref{Batch Mode}.) | 552 | @ref{Batch Mode}.) |
| 552 | 553 | ||
| 553 | If @var{exit-data} is a string, its contents are stuffed into the | 554 | If @var{exit-data} is a string, its contents are stuffed into the |
| @@ -555,35 +556,44 @@ terminal input buffer so that the shell (or whatever program next reads | |||
| 555 | input) can read them. | 556 | input) can read them. |
| 556 | @end deffn | 557 | @end deffn |
| 557 | 558 | ||
| 558 | All the information in the Emacs process, aside from files that have | 559 | @cindex SIGTERM |
| 559 | been saved, is lost when the Emacs process is killed. Because killing | 560 | @cindex SIGHUP |
| 560 | Emacs inadvertently can lose a lot of work, Emacs queries for | 561 | @cindex SIGINT |
| 561 | confirmation before actually terminating if you have buffers that need | 562 | @cindex operating system signal |
| 562 | saving or subprocesses that are running. This is done in the function | 563 | The @code{kill-emacs} function is normally called via the |
| 563 | @code{save-buffers-kill-emacs}, the higher level function from which | 564 | higher-level command @kbd{C-x C-c} |
| 564 | @code{kill-emacs} is usually called. | 565 | (@code{save-buffers-kill-terminal}). @xref{Exiting,,, emacs, The GNU |
| 566 | Emacs Manual}. It is also called automatically if Emacs receives a | ||
| 567 | @code{SIGTERM} or @code{SIGHUP} operating system signal (e.g. when the | ||
| 568 | controlling terminal is disconnected), or if it receives a | ||
| 569 | @code{SIGINT} signal while running in batch mode (@pxref{Batch Mode}). | ||
| 565 | 570 | ||
| 566 | @defvar kill-emacs-query-functions | 571 | @defvar kill-emacs-hook |
| 567 | After asking the standard questions, @code{save-buffers-kill-emacs} | 572 | This normal hook is run by @code{kill-emacs}, before it kills Emacs. |
| 568 | calls the functions in the list @code{kill-emacs-query-functions}, in | 573 | |
| 569 | order of appearance, with no arguments. These functions can ask for | 574 | Because @code{kill-emacs} can be called in situations where user |
| 570 | additional confirmation from the user. If any of them returns | 575 | interaction is impossible (e.g. when the terminal is disconnected), |
| 571 | @code{nil}, @code{save-buffers-kill-emacs} does not kill Emacs, and | 576 | functions on this hook should not attempt to interact with the user. |
| 572 | does not run the remaining functions in this hook. Calling | 577 | If you want to interact with the user when Emacs is shutting down, use |
| 573 | @code{kill-emacs} directly does not run this hook. | 578 | @code{kill-emacs-query-functions}, described below. |
| 574 | @end defvar | 579 | @end defvar |
| 575 | 580 | ||
| 576 | @defvar kill-emacs-hook | 581 | When Emacs is killed, all the information in the Emacs process, |
| 577 | This variable is a normal hook; once @code{save-buffers-kill-emacs} is | 582 | aside from files that have been saved, is lost. Because killing Emacs |
| 578 | finished with all file saving and confirmation, it calls | 583 | inadvertently can lose a lot of work, the |
| 579 | @code{kill-emacs} which runs the functions in this hook. | 584 | @code{save-buffers-kill-terminal} command queries for confirmation if |
| 580 | 585 | you have buffers that need saving or subprocesses that are running. | |
| 581 | @code{kill-emacs} may be invoked directly (that is not via | 586 | It also runs the abnormal hook @code{kill-emacs-query-functions}: |
| 582 | @code{save-buffers-kill-emacs}) if the terminal is disconnected, or in | 587 | |
| 583 | similar situations where interaction with the user is not possible. | 588 | @defvar kill-emacs-query-functions |
| 584 | Thus, if your hook needs to interact with the user, put it on | 589 | When @code{save-buffers-kill-terminal} is killing Emacs, it calls the |
| 585 | @code{kill-emacs-query-functions}; if it needs to run regardless of | 590 | functions in this hook, after asking the standard questions and before |
| 586 | how Emacs is killed, put it on @code{kill-emacs-hook}. | 591 | calling @code{kill-emacs}. The functions are called in order of |
| 592 | appearance, with no arguments. Each function can ask for additional | ||
| 593 | confirmation from the user. If any of them returns @code{nil}, | ||
| 594 | @code{save-buffers-kill-emacs} does not kill Emacs, and does not run | ||
| 595 | the remaining functions in this hook. Calling @code{kill-emacs} | ||
| 596 | directly does not run this hook. | ||
| 587 | @end defvar | 597 | @end defvar |
| 588 | 598 | ||
| 589 | @node Suspending Emacs | 599 | @node Suspending Emacs |