aboutsummaryrefslogtreecommitdiffstats
path: root/doc/misc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/misc')
-rw-r--r--doc/misc/ChangeLog11
-rw-r--r--doc/misc/cl.texi48
-rw-r--r--doc/misc/erc.texi64
-rw-r--r--doc/misc/ses.texi14
-rw-r--r--doc/misc/url.texi2
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 @@
12012-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
12012-11-13 Glenn Morris <rgm@gnu.org> 122012-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
1292accordingly for the duration of the body of the @code{cl-flet}; then 1292accordingly for the duration of the body of the @code{cl-flet}; then
1293the old function definition, or lack thereof, is restored. 1293the old function definition, or lack thereof, is restored.
1294 1294
1295You can use @code{cl-flet} to disable or modify the behavior of a 1295You can use @code{cl-flet} to disable or modify the behavior of
1296function in a temporary fashion. (Compare this with the idea 1296functions (including Emacs primitives) in a temporary, localized fashion.
1297of 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}.)
1299This will even work on Emacs primitives, although note that some calls
1300to primitive functions internal to Emacs are made without going
1301through 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
1309This code attempts to replace the built-in function @code{message} 1300The bindings are lexical in scope. This means that all references to
1310with a function that simply saves the messages in a list rather 1301the named functions must appear physically within the body of the
1311than displaying them. The original definition of @code{message} 1302@code{cl-flet} form.
1312will be restored after @code{do-something} exits. This code will
1313work fine on messages generated by other Lisp code, but messages
1314generated directly inside Emacs will not be caught since they make
1315direct C-language calls to the message routines rather than going
1316through the Lisp @code{message} function.
1317 1303
1318Functions defined by @code{cl-flet} may use the full Common Lisp 1304Functions defined by @code{cl-flet} may use the full Common Lisp
1319argument notation supported by @code{cl-defun}; also, the function 1305argument 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
1323Note that the @file{cl.el} version of this macro behaves slightly 1309Note that the @file{cl.el} version of this macro behaves slightly
1324differently. @xref{Obsolete Macros}. 1310differently. In particular, its binding is dynamic rather than
1311lexical. @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
4863that @code{flet} affects indirect calls to a function as well as calls 4850that @code{flet} affects indirect calls to a function as well as calls
4864directly inside the @code{flet} form itself. 4851directly inside the @code{flet} form itself.
4865 4852
4853This will even work on Emacs primitives, although note that some calls
4854to primitive functions internal to Emacs are made without going
4855through 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
4863This code attempts to replace the built-in function @code{message}
4864with a function that simply saves the messages in a list rather
4865than displaying them. The original definition of @code{message}
4866will be restored after @code{do-something} exits. This code will
4867work fine on messages generated by other Lisp code, but messages
4868generated directly inside Emacs will not be caught since they make
4869direct C-language calls to the message routines rather than going
4870through the Lisp @code{message} function.
4871
4866@c Bug#411. 4872@c Bug#411.
4867Note that many primitives (e.g.@: @code{+}) have special byte-compile 4873Note that many primitives (e.g.@: @code{+}) have special byte-compile
4868handling. Attempts to redefine such functions using @code{flet} will 4874handling. 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
391Wrap long lines 391Wrap long lines
392 392
393@cindex modules, hecomplete
394@item hecomplete
395Complete nicknames and commands (old). This is the old module---you
396might prefer the ``completion'' module instead.
397
398@cindex modules, identd 393@cindex modules, identd
399@item identd 394@item identd
400Launch an identd server on port 8113 395Launch an identd server on port 8113
@@ -427,6 +422,11 @@ Don't display non-IRC commands after evaluation
427@item notify 422@item notify
428Notify when the online status of certain users changes 423Notify when the online status of certain users changes
429 424
425@cindex modules, notifications
426@item notifications
427Send you a notification when you get a private message,
428or your nickname is mentioned
429
430@cindex modules, page 430@cindex modules, page
431@item page 431@item page
432Process CTCP PAGE requests from IRC 432Process CTCP PAGE requests from IRC
@@ -530,7 +530,7 @@ parameters.
530@defun erc-compute-server &optional server 530@defun erc-compute-server &optional server
531Return an IRC server name. 531Return an IRC server name.
532 532
533This tries a number of increasingly more default methods until a non-nil 533This tries a number of increasingly more default methods until a non-@code{nil}
534value is found. 534value 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
546IRC server to use if one is not provided. 546IRC 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
552Return a port for an IRC server. 552Return a port for an IRC server.
553 553
554This tries a number of increasingly more default methods until a non-nil 554This tries a number of increasingly more default methods until a non-@code{nil}
555value is found. 555value is found.
556 556
557@itemize @bullet 557@itemize @bullet
@@ -574,7 +574,7 @@ This can be either a string or a number.
574Return user's IRC nick. 574Return user's IRC nick.
575 575
576This tries a number of increasingly more default methods until a 576This tries a number of increasingly more default methods until a
577non-nil value is found. 577non-@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
601If the nickname you chose isn't available, and this option is non-nil, 601If the nickname you chose isn't available, and this option is non-@code{nil},
602ERC should automatically attempt to connect with another nickname. 602ERC should automatically attempt to connect with another nickname.
603 603
604You can manually set another nickname with the /NICK command. 604You 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
611If non-@code{nil} (the default), @kbd{M-x erc} prompts for a password.
612@end defopt
613
614If 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
616you use @file{~/.authinfo} as your auth-source backend, then put
617something like the following in that file:
618
619@example
620machine irc.example.net login "#fsf" password sEcReT
621@end example
622
623@noindent
624ERC also consults @code{auth-source} to find any channel keys required
625for the channels that you wish to autojoin, as specified by the
626variable @code{erc-autojoin-channels-alist}.
627
628For 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
610Return user's full name. 634Return user's full name.
611 635
612This tries a number of increasingly more default methods until a 636This tries a number of increasingly more default methods until a
613non-nil value is found. 637non-@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
716This section has not yet been written. For now, the easiest way to 740This section is extremely incomplete. For now, the easiest way to
717check out the available options for ERC is to do 741check 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
745If 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
753Like @code{erc-hide-list}, but only applies to messages sent by
754lurkers. The function @code{erc-lurker-p} determines whether a given
755nickname 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.
482Pops up a menu to set the current row as the header, or revert to 482Pops up a menu to set the current row as the header, or revert to
483column letters. 483column 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
486Rename a cell from a standard A1-like name to any 486Rename a cell from a standard A1-like name to any
487string. 487string.
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
490When you interrupt a cell formula update by clicking @kbd{C-g}, then 490When 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
606are empty. Similarly, @code{(ses-range A1 A4 _ )} will do the same as 606are 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
609When order matters, list cells by reading cells rowwise from top left 609When order matters, list cells by reading cells row-wise from top left
610to bottom right. This flag is provided for completeness only as it is 610to bottom right. This flag is provided for completeness only as it is
611the default reading order. 611the default reading order.
612@item <v 612@item <v
613List cells by reading cells rowwise from top right to bottom left. 613List cells by reading cells row-wise from top right to bottom left.
614@item v> 614@item v>
615List cells by reading cells columnwise from top left to bottom right. 615List cells by reading cells column-wise from top left to bottom right.
616@item v< 616@item v<
617List cells by reading cells columnwise from top right to bottom left. 617List cells by reading cells column-wise from top right to bottom left.
618@item v 618@item v
619A short hand for @code{v>}. 619A 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)}.
346The value of this option is an integer specifying the maximum number 346The value of this option is an integer specifying the maximum number
347of concurrent @code{url-queue-retrieve} network processes. If the 347of concurrent @code{url-queue-retrieve} network processes. If the
348number of @code{url-queue-retrieve} calls is larger than this number, 348number of @code{url-queue-retrieve} calls is larger than this number,
349later ones are queued until ealier ones are finished. 349later 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