diff options
Diffstat (limited to 'doc/misc')
| -rw-r--r-- | doc/misc/ChangeLog | 11 | ||||
| -rw-r--r-- | doc/misc/cl.texi | 48 | ||||
| -rw-r--r-- | doc/misc/erc.texi | 64 | ||||
| -rw-r--r-- | doc/misc/ses.texi | 14 | ||||
| -rw-r--r-- | doc/misc/url.texi | 2 |
5 files changed, 97 insertions, 42 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 7322613e0db..b31b67b5d84 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,3 +1,14 @@ | |||
| 1 | 2012-11-16 Glenn Morris <rgm@gnu.org> | ||
| 2 | |||
| 3 | * cl.texi (Function Bindings): Clarify that cl-flet is lexical. | ||
| 4 | (Obsolete Macros): Move example here from Function Bindings. | ||
| 5 | |||
| 6 | * erc.texi: Use @code{nil} rather than just "nil". | ||
| 7 | (Modules): Undocument obsolete "hecomplete". | ||
| 8 | Add "notifications". | ||
| 9 | (Connecting): Add brief section on passwords. | ||
| 10 | (Options): Make a start by adding erc-hide-list, erc-lurker-hide-list. | ||
| 11 | |||
| 1 | 2012-11-13 Glenn Morris <rgm@gnu.org> | 12 | 2012-11-13 Glenn Morris <rgm@gnu.org> |
| 2 | 13 | ||
| 3 | * flymake.texi (Customizable variables) | 14 | * flymake.texi (Customizable variables) |
diff --git a/doc/misc/cl.texi b/doc/misc/cl.texi index a50be1027f3..beefa3e9c40 100644 --- a/doc/misc/cl.texi +++ b/doc/misc/cl.texi | |||
| @@ -1292,28 +1292,14 @@ it were a @code{cl-defun} form. The function @var{name} is defined | |||
| 1292 | accordingly for the duration of the body of the @code{cl-flet}; then | 1292 | accordingly for the duration of the body of the @code{cl-flet}; then |
| 1293 | the old function definition, or lack thereof, is restored. | 1293 | the old function definition, or lack thereof, is restored. |
| 1294 | 1294 | ||
| 1295 | You can use @code{cl-flet} to disable or modify the behavior of a | 1295 | You can use @code{cl-flet} to disable or modify the behavior of |
| 1296 | function in a temporary fashion. (Compare this with the idea | 1296 | functions (including Emacs primitives) in a temporary, localized fashion. |
| 1297 | of advising functions. | 1297 | (Compare this with the idea of advising functions. |
| 1298 | @xref{Advising Functions,,,elisp,GNU Emacs Lisp Reference Manual}.) | 1298 | @xref{Advising Functions,,,elisp,GNU Emacs Lisp Reference Manual}.) |
| 1299 | This will even work on Emacs primitives, although note that some calls | ||
| 1300 | to primitive functions internal to Emacs are made without going | ||
| 1301 | through the symbol's function cell, and so will not be affected by | ||
| 1302 | @code{cl-flet}. For example, | ||
| 1303 | |||
| 1304 | @example | ||
| 1305 | (cl-flet ((message (&rest args) (push args saved-msgs))) | ||
| 1306 | (do-something)) | ||
| 1307 | @end example | ||
| 1308 | 1299 | ||
| 1309 | This code attempts to replace the built-in function @code{message} | 1300 | The bindings are lexical in scope. This means that all references to |
| 1310 | with a function that simply saves the messages in a list rather | 1301 | the named functions must appear physically within the body of the |
| 1311 | than displaying them. The original definition of @code{message} | 1302 | @code{cl-flet} form. |
| 1312 | will be restored after @code{do-something} exits. This code will | ||
| 1313 | work fine on messages generated by other Lisp code, but messages | ||
| 1314 | generated directly inside Emacs will not be caught since they make | ||
| 1315 | direct C-language calls to the message routines rather than going | ||
| 1316 | through the Lisp @code{message} function. | ||
| 1317 | 1303 | ||
| 1318 | Functions defined by @code{cl-flet} may use the full Common Lisp | 1304 | Functions defined by @code{cl-flet} may use the full Common Lisp |
| 1319 | argument notation supported by @code{cl-defun}; also, the function | 1305 | argument notation supported by @code{cl-defun}; also, the function |
| @@ -1321,7 +1307,8 @@ body is enclosed in an implicit block as if by @code{cl-defun}. | |||
| 1321 | @xref{Program Structure}. | 1307 | @xref{Program Structure}. |
| 1322 | 1308 | ||
| 1323 | Note that the @file{cl.el} version of this macro behaves slightly | 1309 | Note that the @file{cl.el} version of this macro behaves slightly |
| 1324 | differently. @xref{Obsolete Macros}. | 1310 | differently. In particular, its binding is dynamic rather than |
| 1311 | lexical. @xref{Obsolete Macros}. | ||
| 1325 | @end defmac | 1312 | @end defmac |
| 1326 | 1313 | ||
| 1327 | @defmac cl-labels (bindings@dots{}) forms@dots{} | 1314 | @defmac cl-labels (bindings@dots{}) forms@dots{} |
| @@ -4863,6 +4850,25 @@ time before Emacs had lexical binding). The result is | |||
| 4863 | that @code{flet} affects indirect calls to a function as well as calls | 4850 | that @code{flet} affects indirect calls to a function as well as calls |
| 4864 | directly inside the @code{flet} form itself. | 4851 | directly inside the @code{flet} form itself. |
| 4865 | 4852 | ||
| 4853 | This will even work on Emacs primitives, although note that some calls | ||
| 4854 | to primitive functions internal to Emacs are made without going | ||
| 4855 | through the symbol's function cell, and so will not be affected by | ||
| 4856 | @code{flet}. For example, | ||
| 4857 | |||
| 4858 | @example | ||
| 4859 | (flet ((message (&rest args) (push args saved-msgs))) | ||
| 4860 | (do-something)) | ||
| 4861 | @end example | ||
| 4862 | |||
| 4863 | This code attempts to replace the built-in function @code{message} | ||
| 4864 | with a function that simply saves the messages in a list rather | ||
| 4865 | than displaying them. The original definition of @code{message} | ||
| 4866 | will be restored after @code{do-something} exits. This code will | ||
| 4867 | work fine on messages generated by other Lisp code, but messages | ||
| 4868 | generated directly inside Emacs will not be caught since they make | ||
| 4869 | direct C-language calls to the message routines rather than going | ||
| 4870 | through the Lisp @code{message} function. | ||
| 4871 | |||
| 4866 | @c Bug#411. | 4872 | @c Bug#411. |
| 4867 | Note that many primitives (e.g.@: @code{+}) have special byte-compile | 4873 | Note that many primitives (e.g.@: @code{+}) have special byte-compile |
| 4868 | handling. Attempts to redefine such functions using @code{flet} will | 4874 | handling. Attempts to redefine such functions using @code{flet} will |
diff --git a/doc/misc/erc.texi b/doc/misc/erc.texi index 378180bef31..834d2ea844d 100644 --- a/doc/misc/erc.texi +++ b/doc/misc/erc.texi | |||
| @@ -390,11 +390,6 @@ Complete nicknames and commands (programmable) | |||
| 390 | @item fill | 390 | @item fill |
| 391 | Wrap long lines | 391 | Wrap long lines |
| 392 | 392 | ||
| 393 | @cindex modules, hecomplete | ||
| 394 | @item hecomplete | ||
| 395 | Complete nicknames and commands (old). This is the old module---you | ||
| 396 | might prefer the ``completion'' module instead. | ||
| 397 | |||
| 398 | @cindex modules, identd | 393 | @cindex modules, identd |
| 399 | @item identd | 394 | @item identd |
| 400 | Launch an identd server on port 8113 | 395 | Launch an identd server on port 8113 |
| @@ -427,6 +422,11 @@ Don't display non-IRC commands after evaluation | |||
| 427 | @item notify | 422 | @item notify |
| 428 | Notify when the online status of certain users changes | 423 | Notify when the online status of certain users changes |
| 429 | 424 | ||
| 425 | @cindex modules, notifications | ||
| 426 | @item notifications | ||
| 427 | Send you a notification when you get a private message, | ||
| 428 | or your nickname is mentioned | ||
| 429 | |||
| 430 | @cindex modules, page | 430 | @cindex modules, page |
| 431 | @item page | 431 | @item page |
| 432 | Process CTCP PAGE requests from IRC | 432 | Process CTCP PAGE requests from IRC |
| @@ -530,7 +530,7 @@ parameters. | |||
| 530 | @defun erc-compute-server &optional server | 530 | @defun erc-compute-server &optional server |
| 531 | Return an IRC server name. | 531 | Return an IRC server name. |
| 532 | 532 | ||
| 533 | This tries a number of increasingly more default methods until a non-nil | 533 | This tries a number of increasingly more default methods until a non-@code{nil} |
| 534 | value is found. | 534 | value is found. |
| 535 | 535 | ||
| 536 | @itemize @bullet | 536 | @itemize @bullet |
| @@ -542,7 +542,7 @@ value is found. | |||
| 542 | 542 | ||
| 543 | @end defun | 543 | @end defun |
| 544 | 544 | ||
| 545 | @defopt erc-server nil | 545 | @defopt erc-server |
| 546 | IRC server to use if one is not provided. | 546 | IRC server to use if one is not provided. |
| 547 | @end defopt | 547 | @end defopt |
| 548 | 548 | ||
| @@ -551,7 +551,7 @@ IRC server to use if one is not provided. | |||
| 551 | @defun erc-compute-port &optional port | 551 | @defun erc-compute-port &optional port |
| 552 | Return a port for an IRC server. | 552 | Return a port for an IRC server. |
| 553 | 553 | ||
| 554 | This tries a number of increasingly more default methods until a non-nil | 554 | This tries a number of increasingly more default methods until a non-@code{nil} |
| 555 | value is found. | 555 | value is found. |
| 556 | 556 | ||
| 557 | @itemize @bullet | 557 | @itemize @bullet |
| @@ -574,7 +574,7 @@ This can be either a string or a number. | |||
| 574 | Return user's IRC nick. | 574 | Return user's IRC nick. |
| 575 | 575 | ||
| 576 | This tries a number of increasingly more default methods until a | 576 | This tries a number of increasingly more default methods until a |
| 577 | non-nil value is found. | 577 | non-@code{nil} value is found. |
| 578 | 578 | ||
| 579 | @itemize | 579 | @itemize |
| 580 | @item @var{nick} (the argument passed to this function) | 580 | @item @var{nick} (the argument passed to this function) |
| @@ -598,19 +598,43 @@ The string to append to the nick if it is already in use. | |||
| 598 | @end defopt | 598 | @end defopt |
| 599 | 599 | ||
| 600 | @defopt erc-try-new-nick-p | 600 | @defopt erc-try-new-nick-p |
| 601 | If the nickname you chose isn't available, and this option is non-nil, | 601 | If the nickname you chose isn't available, and this option is non-@code{nil}, |
| 602 | ERC should automatically attempt to connect with another nickname. | 602 | ERC should automatically attempt to connect with another nickname. |
| 603 | 603 | ||
| 604 | You can manually set another nickname with the /NICK command. | 604 | You can manually set another nickname with the /NICK command. |
| 605 | @end defopt | 605 | @end defopt |
| 606 | 606 | ||
| 607 | @subheading Password | ||
| 608 | @cindex password | ||
| 609 | |||
| 610 | @defopt erc-prompt-for-password | ||
| 611 | If non-@code{nil} (the default), @kbd{M-x erc} prompts for a password. | ||
| 612 | @end defopt | ||
| 613 | |||
| 614 | If you prefer, you can set this option to @code{nil} and use the | ||
| 615 | @code{auth-source} mechanism to store your password. For instance, if | ||
| 616 | you use @file{~/.authinfo} as your auth-source backend, then put | ||
| 617 | something like the following in that file: | ||
| 618 | |||
| 619 | @example | ||
| 620 | machine irc.example.net login "#fsf" password sEcReT | ||
| 621 | @end example | ||
| 622 | |||
| 623 | @noindent | ||
| 624 | ERC also consults @code{auth-source} to find any channel keys required | ||
| 625 | for the channels that you wish to autojoin, as specified by the | ||
| 626 | variable @code{erc-autojoin-channels-alist}. | ||
| 627 | |||
| 628 | For more details, @pxref{Top,,auth-source, auth, Emacs auth-source Library}. | ||
| 629 | |||
| 630 | |||
| 607 | @subheading Full name | 631 | @subheading Full name |
| 608 | 632 | ||
| 609 | @defun erc-compute-full-name &optional full-name | 633 | @defun erc-compute-full-name &optional full-name |
| 610 | Return user's full name. | 634 | Return user's full name. |
| 611 | 635 | ||
| 612 | This tries a number of increasingly more default methods until a | 636 | This tries a number of increasingly more default methods until a |
| 613 | non-nil value is found. | 637 | non-@code{nil} value is found. |
| 614 | 638 | ||
| 615 | @itemize @bullet | 639 | @itemize @bullet |
| 616 | @item @var{full-name} (the argument passed to this function) | 640 | @item @var{full-name} (the argument passed to this function) |
| @@ -713,10 +737,24 @@ stuff, to the current ERC buffer." | |||
| 713 | @c PRE5_4: (Node) Document every ERC option (module options go in | 737 | @c PRE5_4: (Node) Document every ERC option (module options go in |
| 714 | @c previous chapter) | 738 | @c previous chapter) |
| 715 | 739 | ||
| 716 | This section has not yet been written. For now, the easiest way to | 740 | This section is extremely incomplete. For now, the easiest way to |
| 717 | check out the available options for ERC is to do | 741 | check out all the available options for ERC is to do |
| 718 | @kbd{M-x customize-group erc RET}. | 742 | @kbd{M-x customize-group erc RET}. |
| 719 | 743 | ||
| 744 | @defopt erc-hide-list | ||
| 745 | If non, @code{nil}, this is a list of IRC message types to hide, e.g. | ||
| 746 | |||
| 747 | @example | ||
| 748 | (setq erc-hide-list '("JOIN" "PART" "QUIT")) | ||
| 749 | @end example | ||
| 750 | @end defopt | ||
| 751 | |||
| 752 | @defopt erc-lurker-hide-list | ||
| 753 | Like @code{erc-hide-list}, but only applies to messages sent by | ||
| 754 | lurkers. The function @code{erc-lurker-p} determines whether a given | ||
| 755 | nickname is considerd a lurker. | ||
| 756 | @end defopt | ||
| 757 | |||
| 720 | 758 | ||
| 721 | @node Getting Help and Reporting Bugs | 759 | @node Getting Help and Reporting Bugs |
| 722 | @chapter Getting Help and Reporting Bugs | 760 | @chapter Getting Help and Reporting Bugs |
diff --git a/doc/misc/ses.texi b/doc/misc/ses.texi index 5de87a2f1c7..cccd74dec0f 100644 --- a/doc/misc/ses.texi +++ b/doc/misc/ses.texi | |||
| @@ -482,9 +482,9 @@ show column letters again. | |||
| 482 | Pops up a menu to set the current row as the header, or revert to | 482 | Pops up a menu to set the current row as the header, or revert to |
| 483 | column letters. | 483 | column letters. |
| 484 | @item M-x ses-rename-cell | 484 | @item M-x ses-rename-cell |
| 485 | @findex ses-rename-cell | 485 | @findex ses-rename-cell |
| 486 | Rename a cell from a standard A1-like name to any | 486 | Rename a cell from a standard A1-like name to any |
| 487 | string. | 487 | string. |
| 488 | @item M-x ses-repair-cell-reference-all | 488 | @item M-x ses-repair-cell-reference-all |
| 489 | @findex ses-repair-cell-reference-all | 489 | @findex ses-repair-cell-reference-all |
| 490 | When you interrupt a cell formula update by clicking @kbd{C-g}, then | 490 | When you interrupt a cell formula update by clicking @kbd{C-g}, then |
| @@ -606,15 +606,15 @@ instance @code{(ses-range A1 A4 _ "empty")} will do the same as | |||
| 606 | are empty. Similarly, @code{(ses-range A1 A4 _ )} will do the same as | 606 | are empty. Similarly, @code{(ses-range A1 A4 _ )} will do the same as |
| 607 | @code{(list A1 0 A3 0)}. | 607 | @code{(list A1 0 A3 0)}. |
| 608 | @item >v | 608 | @item >v |
| 609 | When order matters, list cells by reading cells rowwise from top left | 609 | When order matters, list cells by reading cells row-wise from top left |
| 610 | to bottom right. This flag is provided for completeness only as it is | 610 | to bottom right. This flag is provided for completeness only as it is |
| 611 | the default reading order. | 611 | the default reading order. |
| 612 | @item <v | 612 | @item <v |
| 613 | List cells by reading cells rowwise from top right to bottom left. | 613 | List cells by reading cells row-wise from top right to bottom left. |
| 614 | @item v> | 614 | @item v> |
| 615 | List cells by reading cells columnwise from top left to bottom right. | 615 | List cells by reading cells column-wise from top left to bottom right. |
| 616 | @item v< | 616 | @item v< |
| 617 | List cells by reading cells columnwise from top right to bottom left. | 617 | List cells by reading cells column-wise from top right to bottom left. |
| 618 | @item v | 618 | @item v |
| 619 | A short hand for @code{v>}. | 619 | A short hand for @code{v>}. |
| 620 | @item ^ | 620 | @item ^ |
diff --git a/doc/misc/url.texi b/doc/misc/url.texi index fdb3ab452f2..90ab7f5554f 100644 --- a/doc/misc/url.texi +++ b/doc/misc/url.texi | |||
| @@ -346,7 +346,7 @@ To use this function, you must @code{(require 'url-queue)}. | |||
| 346 | The value of this option is an integer specifying the maximum number | 346 | The value of this option is an integer specifying the maximum number |
| 347 | of concurrent @code{url-queue-retrieve} network processes. If the | 347 | of concurrent @code{url-queue-retrieve} network processes. If the |
| 348 | number of @code{url-queue-retrieve} calls is larger than this number, | 348 | number of @code{url-queue-retrieve} calls is larger than this number, |
| 349 | later ones are queued until ealier ones are finished. | 349 | later ones are queued until earlier ones are finished. |
| 350 | @end defopt | 350 | @end defopt |
| 351 | 351 | ||
| 352 | @vindex url-queue-timeout | 352 | @vindex url-queue-timeout |