From 6e5e9b70f501a975baa4bce0b8f0854052435ff0 Mon Sep 17 00:00:00 2001 From: Glenn Morris Date: Mon, 12 Nov 2012 19:40:44 -0800 Subject: Document new erc module "notifications" * doc/misc/erc.texi (Modules): Undocument obsolete "hecomplete". Add "notifications". * lisp/erc/erc.el (erc-modules): Add "notifications". Tweak "hecomplete" doc. * etc/NEWS: Related edit. --- doc/misc/ChangeLog | 5 +++++ doc/misc/erc.texi | 10 +++++----- 2 files changed, 10 insertions(+), 5 deletions(-) (limited to 'doc/misc') diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index b3b4ad07147..82e0cd0f856 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog @@ -1,3 +1,8 @@ +2012-11-13 Glenn Morris + + * erc.texi (Modules): Undocument obsolete "hecomplete". + Add "notifications". + 2012-11-12 Glenn Morris * flymake.texi (Customizable variables) diff --git a/doc/misc/erc.texi b/doc/misc/erc.texi index 378180bef31..b5c0dd3c718 100644 --- a/doc/misc/erc.texi +++ b/doc/misc/erc.texi @@ -390,11 +390,6 @@ Complete nicknames and commands (programmable) @item fill Wrap long lines -@cindex modules, hecomplete -@item hecomplete -Complete nicknames and commands (old). This is the old module---you -might prefer the ``completion'' module instead. - @cindex modules, identd @item identd Launch an identd server on port 8113 @@ -427,6 +422,11 @@ Don't display non-IRC commands after evaluation @item notify Notify when the online status of certain users changes +@cindex modules, notifications +@item notifications +Send you a notification when you get a private message, +or your nickname is mentioned + @cindex modules, page @item page Process CTCP PAGE requests from IRC -- cgit v1.2.1 From f925b109e76f36081d9495252fcee204deb4c1fb Mon Sep 17 00:00:00 2001 From: Glenn Morris Date: Tue, 13 Nov 2012 00:05:42 -0800 Subject: * doc/misc/erc.texi (Connecting): Add brief section on passwords. * etc/NEWS: Related edit. --- doc/misc/ChangeLog | 1 + doc/misc/erc.texi | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+) (limited to 'doc/misc') diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 82e0cd0f856..0a837320b43 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog @@ -2,6 +2,7 @@ * erc.texi (Modules): Undocument obsolete "hecomplete". Add "notifications". + (Connecting): Add brief section on passwords. 2012-11-12 Glenn Morris diff --git a/doc/misc/erc.texi b/doc/misc/erc.texi index b5c0dd3c718..ea315cd86fa 100644 --- a/doc/misc/erc.texi +++ b/doc/misc/erc.texi @@ -604,6 +604,30 @@ ERC should automatically attempt to connect with another nickname. You can manually set another nickname with the /NICK command. @end defopt +@subheading Password +@cindex password + +@defopt erc-prompt-for-password +If non-@code{nil} (the default), @kbd{M-x erc} prompts for a password. +@end defopt + +If you prefer, you can set this option to @code{nil} and use the +@code{auth-source} mechanism to store your password. For instance, if +you use @file{~/.authinfo} as your auth-source backend, then put +something like the following in that file: + +@example +machine irc.example.net login "#fsf" password sEcReT +@end example + +@noindent +ERC also consults @code{auth-source} to find any channel keys required +for the channels that you wish to autojoin, as specified by the +variable @code{erc-autojoin-channels-alist}. + +For more details, @pxref{Top,,auth-source, auth, Emacs auth-source Library}. + + @subheading Full name @defun erc-compute-full-name &optional full-name -- cgit v1.2.1 From 274f5de608fd1a4dd99c2f9e4e9214579554f437 Mon Sep 17 00:00:00 2001 From: Glenn Morris Date: Tue, 13 Nov 2012 00:14:15 -0800 Subject: Document erc-lurker-hide-list * doc/misc/erc.texi (Options): Make a start by adding erc-hide-list, erc-lurker-hide-list. * etc/NEWS: Related edit. --- doc/misc/ChangeLog | 1 + doc/misc/erc.texi | 18 ++++++++++++++++-- 2 files changed, 17 insertions(+), 2 deletions(-) (limited to 'doc/misc') diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 0a837320b43..1ec8a3d56ff 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog @@ -3,6 +3,7 @@ * erc.texi (Modules): Undocument obsolete "hecomplete". Add "notifications". (Connecting): Add brief section on passwords. + (Options): Make a start by adding erc-hide-list, erc-lurker-hide-list. 2012-11-12 Glenn Morris diff --git a/doc/misc/erc.texi b/doc/misc/erc.texi index ea315cd86fa..4be94df4b45 100644 --- a/doc/misc/erc.texi +++ b/doc/misc/erc.texi @@ -737,10 +737,24 @@ stuff, to the current ERC buffer." @c PRE5_4: (Node) Document every ERC option (module options go in @c previous chapter) -This section has not yet been written. For now, the easiest way to -check out the available options for ERC is to do +This section is extremely incomplete. For now, the easiest way to +check out all the available options for ERC is to do @kbd{M-x customize-group erc RET}. +@defopt erc-hide-list +If non, @code{nil}, this is a list of IRC message types to hide, e.g. + +@example +(setq erc-hide-list '("JOIN" "PART" "QUIT")) +@end example +@end defopt + +@defopt erc-lurker-hide-list +Like @code{erc-hide-list}, but only applies to messages sent by +lurkers. The function @code{erc-lurker-p} determines whether a given +nickname is considerd a lurker. +@end defopt + @node Getting Help and Reporting Bugs @chapter Getting Help and Reporting Bugs -- cgit v1.2.1 From 5c934f8b268e07b41487dd73133381e6ed324a59 Mon Sep 17 00:00:00 2001 From: Glenn Morris Date: Tue, 13 Nov 2012 00:16:58 -0800 Subject: * doc/misc/erc.texi: Use @code{nil} rather than just "nil". --- doc/misc/ChangeLog | 3 ++- doc/misc/erc.texi | 12 ++++++------ 2 files changed, 8 insertions(+), 7 deletions(-) (limited to 'doc/misc') diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 1ec8a3d56ff..07f38d15dd9 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog @@ -1,6 +1,7 @@ 2012-11-13 Glenn Morris - * erc.texi (Modules): Undocument obsolete "hecomplete". + * erc.texi: Use @code{nil} rather than just "nil". + (Modules): Undocument obsolete "hecomplete". Add "notifications". (Connecting): Add brief section on passwords. (Options): Make a start by adding erc-hide-list, erc-lurker-hide-list. diff --git a/doc/misc/erc.texi b/doc/misc/erc.texi index 4be94df4b45..834d2ea844d 100644 --- a/doc/misc/erc.texi +++ b/doc/misc/erc.texi @@ -530,7 +530,7 @@ parameters. @defun erc-compute-server &optional server Return an IRC server name. -This tries a number of increasingly more default methods until a non-nil +This tries a number of increasingly more default methods until a non-@code{nil} value is found. @itemize @bullet @@ -542,7 +542,7 @@ value is found. @end defun -@defopt erc-server nil +@defopt erc-server IRC server to use if one is not provided. @end defopt @@ -551,7 +551,7 @@ IRC server to use if one is not provided. @defun erc-compute-port &optional port Return a port for an IRC server. -This tries a number of increasingly more default methods until a non-nil +This tries a number of increasingly more default methods until a non-@code{nil} value is found. @itemize @bullet @@ -574,7 +574,7 @@ This can be either a string or a number. Return user's IRC nick. This tries a number of increasingly more default methods until a -non-nil value is found. +non-@code{nil} value is found. @itemize @item @var{nick} (the argument passed to this function) @@ -598,7 +598,7 @@ The string to append to the nick if it is already in use. @end defopt @defopt erc-try-new-nick-p -If the nickname you chose isn't available, and this option is non-nil, +If the nickname you chose isn't available, and this option is non-@code{nil}, ERC should automatically attempt to connect with another nickname. You can manually set another nickname with the /NICK command. @@ -634,7 +634,7 @@ For more details, @pxref{Top,,auth-source, auth, Emacs auth-source Library}. Return user's full name. This tries a number of increasingly more default methods until a -non-nil value is found. +non-@code{nil} value is found. @itemize @bullet @item @var{full-name} (the argument passed to this function) -- cgit v1.2.1 From 7831fb1b9e88be1c18920b36129c6d1933dbd7ea Mon Sep 17 00:00:00 2001 From: Paul Eggert Date: Tue, 13 Nov 2012 21:07:33 -0800 Subject: Spelling fixes. --- doc/misc/ses.texi | 14 +++++++------- doc/misc/url.texi | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) (limited to 'doc/misc') 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. Pops up a menu to set the current row as the header, or revert to column letters. @item M-x ses-rename-cell -@findex ses-rename-cell -Rename a cell from a standard A1-like name to any -string. +@findex ses-rename-cell +Rename a cell from a standard A1-like name to any +string. @item M-x ses-repair-cell-reference-all @findex ses-repair-cell-reference-all 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 are empty. Similarly, @code{(ses-range A1 A4 _ )} will do the same as @code{(list A1 0 A3 0)}. @item >v -When order matters, list cells by reading cells rowwise from top left +When order matters, list cells by reading cells row-wise from top left to bottom right. This flag is provided for completeness only as it is the default reading order. @item -List cells by reading cells columnwise from top left to bottom right. +List cells by reading cells column-wise from top left to bottom right. @item v< -List cells by reading cells columnwise from top right to bottom left. +List cells by reading cells column-wise from top right to bottom left. @item v A short hand for @code{v>}. @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)}. The value of this option is an integer specifying the maximum number of concurrent @code{url-queue-retrieve} network processes. If the number of @code{url-queue-retrieve} calls is larger than this number, -later ones are queued until ealier ones are finished. +later ones are queued until earlier ones are finished. @end defopt @vindex url-queue-timeout -- cgit v1.2.1 From e8693c969a822ad8192f2410fbf9a949a723ddce Mon Sep 17 00:00:00 2001 From: Glenn Morris Date: Thu, 15 Nov 2012 23:43:24 -0800 Subject: cl.texi flet clarification * doc/misc/cl.texi (Function Bindings): Clarify that cl-flet is lexical. (Obsolete Macros): Move example here from Function Bindings. * etc/NEWS: Related edit. --- doc/misc/ChangeLog | 5 +++++ doc/misc/cl.texi | 48 +++++++++++++++++++++++++++--------------------- 2 files changed, 32 insertions(+), 21 deletions(-) (limited to 'doc/misc') diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 07f38d15dd9..4a3c8778e88 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog @@ -1,3 +1,8 @@ +2012-11-16 Glenn Morris + + * cl.texi (Function Bindings): Clarify that cl-flet is lexical. + (Obsolete Macros): Move example here from Function Bindings. + 2012-11-13 Glenn Morris * erc.texi: Use @code{nil} rather than just "nil". 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 accordingly for the duration of the body of the @code{cl-flet}; then the old function definition, or lack thereof, is restored. -You can use @code{cl-flet} to disable or modify the behavior of a -function in a temporary fashion. (Compare this with the idea -of advising functions. +You can use @code{cl-flet} to disable or modify the behavior of +functions (including Emacs primitives) in a temporary, localized fashion. +(Compare this with the idea of advising functions. @xref{Advising Functions,,,elisp,GNU Emacs Lisp Reference Manual}.) -This will even work on Emacs primitives, although note that some calls -to primitive functions internal to Emacs are made without going -through the symbol's function cell, and so will not be affected by -@code{cl-flet}. For example, - -@example -(cl-flet ((message (&rest args) (push args saved-msgs))) - (do-something)) -@end example -This code attempts to replace the built-in function @code{message} -with a function that simply saves the messages in a list rather -than displaying them. The original definition of @code{message} -will be restored after @code{do-something} exits. This code will -work fine on messages generated by other Lisp code, but messages -generated directly inside Emacs will not be caught since they make -direct C-language calls to the message routines rather than going -through the Lisp @code{message} function. +The bindings are lexical in scope. This means that all references to +the named functions must appear physically within the body of the +@code{cl-flet} form. Functions defined by @code{cl-flet} may use the full Common Lisp 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}. @xref{Program Structure}. Note that the @file{cl.el} version of this macro behaves slightly -differently. @xref{Obsolete Macros}. +differently. In particular, its binding is dynamic rather than +lexical. @xref{Obsolete Macros}. @end defmac @defmac cl-labels (bindings@dots{}) forms@dots{} @@ -4863,6 +4850,25 @@ time before Emacs had lexical binding). The result is that @code{flet} affects indirect calls to a function as well as calls directly inside the @code{flet} form itself. +This will even work on Emacs primitives, although note that some calls +to primitive functions internal to Emacs are made without going +through the symbol's function cell, and so will not be affected by +@code{flet}. For example, + +@example +(flet ((message (&rest args) (push args saved-msgs))) + (do-something)) +@end example + +This code attempts to replace the built-in function @code{message} +with a function that simply saves the messages in a list rather +than displaying them. The original definition of @code{message} +will be restored after @code{do-something} exits. This code will +work fine on messages generated by other Lisp code, but messages +generated directly inside Emacs will not be caught since they make +direct C-language calls to the message routines rather than going +through the Lisp @code{message} function. + @c Bug#411. Note that many primitives (e.g.@: @code{+}) have special byte-compile handling. Attempts to redefine such functions using @code{flet} will -- cgit v1.2.1