diff options
| author | Alex Schroeder | 2007-12-20 13:28:50 +0000 |
|---|---|---|
| committer | Alex Schroeder | 2007-12-20 13:28:50 +0000 |
| commit | 331e4d02f9e81ef33982294503c8229d3150b9a0 (patch) | |
| tree | fcd68e587463aab4321f14854bf81b72a781361d /doc | |
| parent | 54371585f73e169cd80782592b87d91d4d6bfbfd (diff) | |
| download | emacs-331e4d02f9e81ef33982294503c8229d3150b9a0.tar.gz emacs-331e4d02f9e81ef33982294503c8229d3150b9a0.zip | |
(Top): Fighting Information Overload chapter added.
(Getting started with rcirc): Add notice of rcirc-track-minor-mode.
(rcirc commands): Moved /ignore command to the new chapter.
(Fighting Information Overload): New chapter documenting /keyword,
/bright, /dim, channel ignore, and low priority channels.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/misc/ChangeLog | 8 | ||||
| -rw-r--r-- | doc/misc/rcirc.texi | 191 |
2 files changed, 179 insertions, 20 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 291587079f2..707b6df77f5 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,3 +1,11 @@ | |||
| 1 | 2007-12-20 Alex Schroeder <alex@gnu.org> | ||
| 2 | |||
| 3 | * rcirc.texi (Top): Fighting Information Overload chapter added. | ||
| 4 | (Getting started with rcirc): Add notice of rcirc-track-minor-mode. | ||
| 5 | (rcirc commands): Moved /ignore command to the new chapter. | ||
| 6 | (Fighting Information Overload): New chapter documenting /keyword, | ||
| 7 | /bright, /dim, channel ignore, and low priority channels. | ||
| 8 | |||
| 1 | 2007-12-16 Michael Albinus <michael.albinus@gmx.de> | 9 | 2007-12-16 Michael Albinus <michael.albinus@gmx.de> |
| 2 | 10 | ||
| 3 | * dbus.texi (Signals): Fix example in dbus-register-signal. | 11 | * dbus.texi (Signals): Fix example in dbus-register-signal. |
diff --git a/doc/misc/rcirc.texi b/doc/misc/rcirc.texi index f6d807f971f..c60022420fb 100644 --- a/doc/misc/rcirc.texi +++ b/doc/misc/rcirc.texi | |||
| @@ -54,6 +54,7 @@ just one other user. | |||
| 54 | @menu | 54 | @menu |
| 55 | * Basics:: | 55 | * Basics:: |
| 56 | * Reference:: | 56 | * Reference:: |
| 57 | * Fighting Information Overload:: | ||
| 57 | * Hacking and Tweaking:: | 58 | * Hacking and Tweaking:: |
| 58 | * GNU Free Documentation License:: | 59 | * GNU Free Documentation License:: |
| 59 | * Key Index:: | 60 | * Key Index:: |
| @@ -74,6 +75,13 @@ Reference | |||
| 74 | * Useful IRC commands:: | 75 | * Useful IRC commands:: |
| 75 | * Configuration:: | 76 | * Configuration:: |
| 76 | 77 | ||
| 78 | Fighting Information Overload | ||
| 79 | |||
| 80 | * Channels:: | ||
| 81 | * People:: | ||
| 82 | * Keywords:: | ||
| 83 | * Notices:: | ||
| 84 | |||
| 77 | Hacking and Tweaking | 85 | Hacking and Tweaking |
| 78 | 86 | ||
| 79 | * Skipping /away messages using handlers:: | 87 | * Skipping /away messages using handlers:: |
| @@ -225,7 +233,16 @@ C-c} to finish editing. You still need to press @key{RET} to send it, | |||
| 225 | though. Generally, IRC users don't like people pasting more than around | 233 | though. Generally, IRC users don't like people pasting more than around |
| 226 | four lines of code, so use with care. | 234 | four lines of code, so use with care. |
| 227 | 235 | ||
| 228 | @node Reference, Hacking and Tweaking, Basics, Top | 236 | As soon as you have joined a channel, you probably want to be notified |
| 237 | of any activity on the the channels you joined. All you need to do is | ||
| 238 | switch channel tracking on using @kbd{M-x rcirc-track-minor-mode}. To | ||
| 239 | make this permanent, add the following to your init file: | ||
| 240 | |||
| 241 | @example | ||
| 242 | (rcirc-track-minor-mode 1) | ||
| 243 | @end example | ||
| 244 | |||
| 245 | @node Reference, Fighting Information Overload, Basics, Top | ||
| 229 | @chapter Reference | 246 | @chapter Reference |
| 230 | @cindex reference | 247 | @cindex reference |
| 231 | 248 | ||
| @@ -382,24 +399,6 @@ buffer, you automatically quit the server and part all channels. (Also | |||
| 382 | @code{/quit ZZZzzz...}.) | 399 | @code{/quit ZZZzzz...}.) |
| 383 | @end table | 400 | @end table |
| 384 | 401 | ||
| 385 | Some commands may not have a key binding, but only be available as typed | ||
| 386 | commands, such as: | ||
| 387 | |||
| 388 | @table @code | ||
| 389 | @item /ignore | ||
| 390 | @cindex /ignore | ||
| 391 | @cindex ignoring other people | ||
| 392 | @cindex trolls, ignoring | ||
| 393 | @cindex hide some posts | ||
| 394 | @cindex idiots online | ||
| 395 | This command toggles the ignore status of a nick, if you provide one. | ||
| 396 | If you don't provide a nick, the command lists all the nicks you are | ||
| 397 | ignoring. All messages by ignored nicks are---you guessed it---ignored. | ||
| 398 | Since only ``operators'' can kick people from channels, the | ||
| 399 | ignore command is often the only way to deal with some of the more | ||
| 400 | obnoxious fellows online. Example: @code{/ignore xah}. | ||
| 401 | @end table | ||
| 402 | |||
| 403 | @node Useful IRC commands, Configuration, rcirc commands, Reference | 402 | @node Useful IRC commands, Configuration, rcirc commands, Reference |
| 404 | @section Useful IRC commands | 403 | @section Useful IRC commands |
| 405 | @cindex irc commands | 404 | @cindex irc commands |
| @@ -556,8 +555,30 @@ Later, you will tell Bitlbee about your accounts and passwords on all | |||
| 556 | the other instant messaging services, and Bitlbee will log you in. All | 555 | the other instant messaging services, and Bitlbee will log you in. All |
| 557 | @code{rcirc} needs to know, is the login to your Bitlbee account. Don't | 556 | @code{rcirc} needs to know, is the login to your Bitlbee account. Don't |
| 558 | confuse the Bitlbee account with all the other accounts. | 557 | confuse the Bitlbee account with all the other accounts. |
| 558 | |||
| 559 | @end table | 559 | @end table |
| 560 | 560 | ||
| 561 | @node Fighting Information Overload, Hacking and Tweaking, Reference, Top | ||
| 562 | @chapter Fighting Information Overload | ||
| 563 | @cindex information overload | ||
| 564 | |||
| 565 | This is the section of the manual that caters to the busy person | ||
| 566 | online. There are support channels with several hundred people in | ||
| 567 | them. Trying to follow a conversation in these channels can be a | ||
| 568 | daunting task. This chapters tells you how @code{rcirc} can help. | ||
| 569 | |||
| 570 | @menu | ||
| 571 | * Channels:: | ||
| 572 | * People:: | ||
| 573 | * Keywords:: | ||
| 574 | * Notices:: | ||
| 575 | @end menu | ||
| 576 | |||
| 577 | @node Channels, People, Fighting Information Overload, Fighting Information Overload | ||
| 578 | @section Channels | ||
| 579 | @cindex channels | ||
| 580 | @cindex modeline | ||
| 581 | |||
| 561 | @kindex C-c C-SPC | 582 | @kindex C-c C-SPC |
| 562 | @vindex rcirc-track-minor-mode | 583 | @vindex rcirc-track-minor-mode |
| 563 | @cindex switching channels | 584 | @cindex switching channels |
| @@ -590,7 +611,137 @@ activation of this mode: | |||
| 590 | (rcirc-track-minor-mode 1))) | 611 | (rcirc-track-minor-mode 1))) |
| 591 | @end example | 612 | @end example |
| 592 | 613 | ||
| 593 | @node Hacking and Tweaking, GNU Free Documentation License, Reference, Top | 614 | @cindex busy channels |
| 615 | If you've joined a very active support channel, tracking activity is | ||
| 616 | no longer useful. The channel will be always active. Switching to | ||
| 617 | active channels using @kbd{C-c C-@key{SPC}} no longer works as | ||
| 618 | expected. | ||
| 619 | |||
| 620 | @kindex C-c C-l | ||
| 621 | @cindex low priority channels | ||
| 622 | The solution is to mark this channel as as a low priority channel. | ||
| 623 | Use @kbd{C-c C-l} to make the current channel a low-priority | ||
| 624 | channel. Low priority channels have the modeline indicator ``LowPri''. | ||
| 625 | @kbd{C-c C-@key{SPC}} will not switch to low priority channels unless | ||
| 626 | you use the @kbd{C-u} prefix. | ||
| 627 | |||
| 628 | @kindex C-c TAB | ||
| 629 | @cindex ignored channels | ||
| 630 | If you prefer a channel to never show up in the modeline, then you | ||
| 631 | have to ignore it. Use @kbd{C-c @key{TAB}} to ignore the current | ||
| 632 | channel. | ||
| 633 | |||
| 634 | @node People, Keywords, Channels, Fighting Information Overload | ||
| 635 | @section People | ||
| 636 | @cindex people, how to ignore | ||
| 637 | @cindex nicks, how to ignore | ||
| 638 | @cindex friends | ||
| 639 | @cindex buddies | ||
| 640 | @cindex trolls | ||
| 641 | |||
| 642 | The most important command available to the discerning IRC user is | ||
| 643 | @code{/ignore}. It's the big equalizer online: If people aggravate | ||
| 644 | you, just ignore them. | ||
| 645 | |||
| 646 | This is of course a crude all-or-nothing solution. Fear not, | ||
| 647 | @code{rcirc} offers alternatives: You can ``brighten'' your buddies | ||
| 648 | and ``dim'' certain other nicks that you don't want to ignore | ||
| 649 | altogether. | ||
| 650 | |||
| 651 | @table @code | ||
| 652 | @item /ignore | ||
| 653 | @cindex /ignore | ||
| 654 | @cindex ignoring other people | ||
| 655 | @cindex trolls, ignoring | ||
| 656 | @cindex hide some posts | ||
| 657 | @cindex idiots online | ||
| 658 | This command toggles the ignore status of a nick, if you provide one. | ||
| 659 | If you don't provide a nick, the command lists all the nicks you are | ||
| 660 | ignoring. All messages by ignored nicks are---you guessed it---ignored. | ||
| 661 | Since only ``operators'' can kick people from channels, the | ||
| 662 | ignore command is often the only way to deal with some of the more | ||
| 663 | obnoxious fellows online. Example: @code{/ignore xah}. | ||
| 664 | |||
| 665 | @item /bright | ||
| 666 | @cindex /bright | ||
| 667 | @cindex highlight other people | ||
| 668 | @cindex friends, highlight | ||
| 669 | @cindex buddies, highlight | ||
| 670 | @cindex nicks, highlight | ||
| 671 | @cindex brighten nicks | ||
| 672 | This command toggles the bright status of a nick, if you provide one. | ||
| 673 | If you don't provide a nick, the command lists all the ``brightened'' | ||
| 674 | nicks. All messages by brightened nicks are---you guessed | ||
| 675 | it---brightened. Use this for your friends. Example: @code{/bright | ||
| 676 | rcy}. | ||
| 677 | |||
| 678 | @item /dim | ||
| 679 | @cindex /dim | ||
| 680 | @cindex soft-ignore other people | ||
| 681 | @cindex obnoxious people online | ||
| 682 | @cindex rabble online | ||
| 683 | This command toggles the dim status of a nick, if you provide one. If | ||
| 684 | you don't provide a nick, the command lists all the ``dimmed'' nicks. | ||
| 685 | All messages by dimmed nicks are---you guessed it---dimmed. Use this | ||
| 686 | for boring people and bots. If you are tracking channel activity, | ||
| 687 | messages by dimmed nicks will not register as activity. Example: | ||
| 688 | @code{/dim fsbot}. | ||
| 689 | @end table | ||
| 690 | |||
| 691 | |||
| 692 | @node Keywords, Notices, People, Fighting Information Overload | ||
| 693 | @section Keywords | ||
| 694 | @cindex keywords | ||
| 695 | |||
| 696 | On a busy channel, you might want to ignore all activity (using | ||
| 697 | @kbd{C-c @key{TAB}}) and just watch for certain keywords. The | ||
| 698 | following command allows you to highlight certain keywords: | ||
| 699 | |||
| 700 | @table @code | ||
| 701 | @item /keyword | ||
| 702 | @cindex /keyword | ||
| 703 | This command toggles the highlighting of a keyword, if you provide | ||
| 704 | one. If you don't provide a keyword, the current keywords are | ||
| 705 | listed. Example: @code{/keyword manual}. | ||
| 706 | @end table | ||
| 707 | |||
| 708 | A keyword is regular expression matching a word. Thus, if you add the | ||
| 709 | keyword @code{wikis?} then this will match the words ``wiki'' and | ||
| 710 | ``wikis'' but not ``emacswiki''. | ||
| 711 | |||
| 712 | @node Notices, , Keywords, Fighting Information Overload | ||
| 713 | @section Notices | ||
| 714 | @cindex part notices, how to omit | ||
| 715 | @cindex join notices, how to omit | ||
| 716 | @cindex quit notices, how to omit | ||
| 717 | @cindex nick notices, how to omit | ||
| 718 | |||
| 719 | @kindex C-c C-o | ||
| 720 | @cindex low priority channels | ||
| 721 | In busy channels you might not be interested in all the joining, | ||
| 722 | parting, quitting, and renaming that goes on. You can omit those | ||
| 723 | notices using @kbd{C-c C-o}. | ||
| 724 | |||
| 725 | @vindex rcirc-omit-responses | ||
| 726 | @cindex away notices, how to omit | ||
| 727 | You can control which notices get omitted via the | ||
| 728 | @code{rcirc-omit-responses} variable. Here's an example of how to omit | ||
| 729 | away messages: | ||
| 730 | |||
| 731 | @example | ||
| 732 | (setq rcirc-omit-responses '("JOIN" "PART" "QUIT" "NICK" "AWAY)) | ||
| 733 | @end example | ||
| 734 | |||
| 735 | @vindex rcirc-omit-threshold | ||
| 736 | Notice that these messages will not be omitted if the nick in question | ||
| 737 | has recently been active. After all, you don't want to continue a | ||
| 738 | conversation with somebody who just left. That's why @code{rcirc} | ||
| 739 | checks recent lines in the buffer to figure out if a nick has been | ||
| 740 | active and only omits a message if the nick has not been active. The | ||
| 741 | window @code{rcirc} considers is controlled by the | ||
| 742 | @code{rcirc-omit-threshold} variable. | ||
| 743 | |||
| 744 | @node Hacking and Tweaking, GNU Free Documentation License, Fighting Information Overload, Top | ||
| 594 | @chapter Hacking and Tweaking | 745 | @chapter Hacking and Tweaking |
| 595 | @cindex hacking and tweaking | 746 | @cindex hacking and tweaking |
| 596 | 747 | ||