diff options
Diffstat (limited to 'doc/misc/erc.texi')
| -rw-r--r-- | doc/misc/erc.texi | 64 |
1 files changed, 51 insertions, 13 deletions
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 |