diff options
| author | Alex Schroeder | 2007-12-21 10:05:46 +0000 |
|---|---|---|
| committer | Alex Schroeder | 2007-12-21 10:05:46 +0000 |
| commit | 99a3e35f970a1c5da44e271f2471bd99d83d233a (patch) | |
| tree | e87e5f989a296d30b231336419ddd72cb7cae594 /doc/misc | |
| parent | 125a630ff6a78ef5658478f547c369ad4b266860 (diff) | |
| download | emacs-99a3e35f970a1c5da44e271f2471bd99d83d233a.tar.gz emacs-99a3e35f970a1c5da44e271f2471bd99d83d233a.zip | |
Changed single spaces after sentence end to double
spaces. Fixed some typos.
(Internet Relay Chat): Explain relay.
(Getting started with rcirc): Change items to reflect prompts.
Add more explanation to rcirc-track-minor-mode and added a comment to
warn future maintainers that this section is a copy.
Diffstat (limited to 'doc/misc')
| -rw-r--r-- | doc/misc/ChangeLog | 9 | ||||
| -rw-r--r-- | doc/misc/rcirc.texi | 107 |
2 files changed, 66 insertions, 50 deletions
diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 93659ea9ade..9256c41b58d 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog | |||
| @@ -1,3 +1,12 @@ | |||
| 1 | 2007-12-21 Alex Schroeder <alex@gnu.org> | ||
| 2 | |||
| 3 | * rcirc.texi: Changed single spaces after sentence end to double | ||
| 4 | spaces. Fixed some typos. | ||
| 5 | (Internet Relay Chat): Explain relay. | ||
| 6 | (Getting started with rcirc): Change items to reflect prompts. | ||
| 7 | Add more explanation to rcirc-track-minor-mode and added a comment to | ||
| 8 | warn future maintainers that this section is a copy. | ||
| 9 | |||
| 1 | 2007-12-20 Alex Schroeder <alex@gnu.org> | 10 | 2007-12-20 Alex Schroeder <alex@gnu.org> |
| 2 | 11 | ||
| 3 | * rcirc.texi (Top): Fighting Information Overload chapter added. | 12 | * rcirc.texi (Top): Fighting Information Overload chapter added. |
diff --git a/doc/misc/rcirc.texi b/doc/misc/rcirc.texi index 1fdb6238285..c521b39c68b 100644 --- a/doc/misc/rcirc.texi +++ b/doc/misc/rcirc.texi | |||
| @@ -120,8 +120,8 @@ communication. | |||
| 120 | @cindex server | 120 | @cindex server |
| 121 | @cindex network | 121 | @cindex network |
| 122 | Contrary to most Instant Messenger (IM) systems, users usually don't | 122 | Contrary to most Instant Messenger (IM) systems, users usually don't |
| 123 | connect to a central server. Instead, users connect to a random server | 123 | connect to a central server. Instead, users connect to a random |
| 124 | in a network, and the servers share information between them. | 124 | server in a network, and servers relay messages from one to the next. |
| 125 | 125 | ||
| 126 | Here's a typical example: | 126 | Here's a typical example: |
| 127 | 127 | ||
| @@ -174,7 +174,7 @@ using a different nick. This will prompt you for four things: | |||
| 174 | @table @asis | 174 | @table @asis |
| 175 | @cindex server, connecting | 175 | @cindex server, connecting |
| 176 | @cindex Freenode network | 176 | @cindex Freenode network |
| 177 | @item IRC server | 177 | @item IRC Server |
| 178 | What server do you want to connect to? All the servers in a particular | 178 | What server do you want to connect to? All the servers in a particular |
| 179 | network are equivalent. Some networks use a round-robin system where a | 179 | network are equivalent. Some networks use a round-robin system where a |
| 180 | single server redirects new connections to a random server in the | 180 | single server redirects new connections to a random server in the |
| @@ -185,7 +185,7 @@ communities and organizations.'' | |||
| 185 | 185 | ||
| 186 | @cindex port, connecting | 186 | @cindex port, connecting |
| 187 | @cindex 6667, default IRC port | 187 | @cindex 6667, default IRC port |
| 188 | @item IRC port | 188 | @item IRC Port |
| 189 | All network connections require a port. Just as web servers and clients | 189 | All network connections require a port. Just as web servers and clients |
| 190 | use port 80 per default, IRC uses port 6667 per default. You rarely | 190 | use port 80 per default, IRC uses port 6667 per default. You rarely |
| 191 | have to use a different port. | 191 | have to use a different port. |
| @@ -193,7 +193,7 @@ have to use a different port. | |||
| 193 | @cindex nick, connecting | 193 | @cindex nick, connecting |
| 194 | @cindex changing nick | 194 | @cindex changing nick |
| 195 | @cindex name changes | 195 | @cindex name changes |
| 196 | @item IRC nick | 196 | @item IRC Nick |
| 197 | @vindex user-login-name | 197 | @vindex user-login-name |
| 198 | Every users needs a handle on-line. You will automatically be assigned | 198 | Every users needs a handle on-line. You will automatically be assigned |
| 199 | a slightly different nick if your chosen nick is already in use. If | 199 | a slightly different nick if your chosen nick is already in use. If |
| @@ -203,7 +203,7 @@ in use, you might for example get assigned the nick @code{alex`}. | |||
| 203 | @cindex channels, connecting | 203 | @cindex channels, connecting |
| 204 | @cindex initial channels | 204 | @cindex initial channels |
| 205 | @cindex startup channels | 205 | @cindex startup channels |
| 206 | @item Channels | 206 | @item IRC Channels |
| 207 | A space separated list of channels you want to join when connecting. | 207 | A space separated list of channels you want to join when connecting. |
| 208 | You don't need to join any channels, if you just want to have one-to-one | 208 | You don't need to join any channels, if you just want to have one-to-one |
| 209 | conversations with friends on the same network. If you're new to the | 209 | conversations with friends on the same network. If you're new to the |
| @@ -219,7 +219,7 @@ and a channel buffer for each of the channels you wanted to join. | |||
| 219 | @kindex RET | 219 | @kindex RET |
| 220 | @cindex talking | 220 | @cindex talking |
| 221 | @cindex communicating | 221 | @cindex communicating |
| 222 | To talk in a channel, just type in what you want to say in a channel | 222 | To talk in a channel, just type what you want to say in a channel |
| 223 | buffer, and press @key{RET}. | 223 | buffer, and press @key{RET}. |
| 224 | 224 | ||
| 225 | @kindex C-c C-c | 225 | @kindex C-c C-c |
| @@ -233,15 +233,20 @@ C-c} to finish editing. You still need to press @key{RET} to send it, | |||
| 233 | 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 |
| 234 | four lines of code, so use with care. | 234 | four lines of code, so use with care. |
| 235 | 235 | ||
| 236 | As soon as you have joined a channel, you probably want to be notified | 236 | @comment This section copied from the Channels section. |
| 237 | of any activity on the the channels you joined. All you need to do is | 237 | @comment All index markers should point to the original! |
| 238 | switch channel tracking on using @kbd{M-x rcirc-track-minor-mode}. To | 238 | Once you are connected to multiple channels, or once you've turned you |
| 239 | make this permanent, add the following to your init file: | 239 | attention to other buffers in Emacs, you probably want to be notified |
| 240 | of any activity in channels not currently visible. All you need to do | ||
| 241 | is switch channel tracking on using @kbd{M-x rcirc-track-minor-mode}. | ||
| 242 | To make this permanent, add the following to your init file: | ||
| 240 | 243 | ||
| 241 | @example | 244 | @example |
| 242 | (rcirc-track-minor-mode 1) | 245 | (rcirc-track-minor-mode 1) |
| 243 | @end example | 246 | @end example |
| 244 | 247 | ||
| 248 | Use @kbd{C-c C-@key{SPC}} to switch to these buffers. | ||
| 249 | |||
| 245 | @node Reference, Fighting Information Overload, Basics, Top | 250 | @node Reference, Fighting Information Overload, Basics, Top |
| 246 | @chapter Reference | 251 | @chapter Reference |
| 247 | @cindex reference | 252 | @cindex reference |
| @@ -443,11 +448,12 @@ liking. | |||
| 443 | @cindex servers, configuration | 448 | @cindex servers, configuration |
| 444 | @cindex initial servers, configuration | 449 | @cindex initial servers, configuration |
| 445 | @cindex startup servers, configuration | 450 | @cindex startup servers, configuration |
| 446 | This variable contains an alist of servers to connect to by default and | 451 | This variable contains an alist of servers to connect to by default |
| 447 | the keywords parameters to use. The keyword parameters are optional. If | 452 | and the keywords parameters to use. The keyword parameters are |
| 448 | you don't provide any, the defaults as documented below will be used. | 453 | optional. If you don't provide any, the defaults as documented below |
| 454 | will be used. | ||
| 449 | 455 | ||
| 450 | The most important parameter is the @code{:channels} parameter. It | 456 | The most important parameter is the @code{:channels} parameter. It |
| 451 | controls which channels you will join by default as soon as you are | 457 | controls which channels you will join by default as soon as you are |
| 452 | connected to the server. | 458 | connected to the server. |
| 453 | 459 | ||
| @@ -476,14 +482,14 @@ This overrides @code{rcirc-default-user-name}. | |||
| 476 | This overrides @code{rcirc-default-full-name}. | 482 | This overrides @code{rcirc-default-full-name}. |
| 477 | 483 | ||
| 478 | @item :channels | 484 | @item :channels |
| 479 | This describes which channels to join when connecting to the server. If | 485 | This describes which channels to join when connecting to the server. |
| 480 | absent, no channels will be connected to automatically. | 486 | If absent, no channels will be connected to automatically. |
| 481 | 487 | ||
| 482 | @end table | 488 | @end table |
| 483 | 489 | ||
| 484 | @item rcirc-default-nick | 490 | @item rcirc-default-nick |
| 485 | @vindex rcirc-default-nick | 491 | @vindex rcirc-default-nick |
| 486 | This variable is used for the default nick. It defaults to the login | 492 | This variable is used for the default nick. It defaults to the login |
| 487 | name returned by @code{user-login-name}. | 493 | name returned by @code{user-login-name}. |
| 488 | 494 | ||
| 489 | @example | 495 | @example |
| @@ -493,24 +499,24 @@ name returned by @code{user-login-name}. | |||
| 493 | @item rcirc-default-port | 499 | @item rcirc-default-port |
| 494 | @vindex rcirc-default-port | 500 | @vindex rcirc-default-port |
| 495 | @cindex port | 501 | @cindex port |
| 496 | This variable contains the default port to connect to. It is 6667 by | 502 | This variable contains the default port to connect to. It is 6667 by |
| 497 | default and rarely needs changing. | 503 | default and rarely needs changing. |
| 498 | 504 | ||
| 499 | @item rcirc-default-user-name | 505 | @item rcirc-default-user-name |
| 500 | @vindex rcirc-default-user-name | 506 | @vindex rcirc-default-user-name |
| 501 | @cindex user name | 507 | @cindex user name |
| 502 | This variable contains the default user name to report to the server. It | 508 | This variable contains the default user name to report to the server. |
| 503 | defaults to the login name returned by @code{user-login-name}, just like | 509 | It defaults to the login name returned by @code{user-login-name}, just |
| 504 | @code{rcirc-default-nick}. | 510 | like @code{rcirc-default-nick}. |
| 505 | 511 | ||
| 506 | @item rcirc-default-user-full-name | 512 | @item rcirc-default-user-full-name |
| 507 | @vindex rcirc-default-user-full-name | 513 | @vindex rcirc-default-user-full-name |
| 508 | @cindex full name | 514 | @cindex full name |
| 509 | @cindex real name | 515 | @cindex real name |
| 510 | @cindex surname | 516 | @cindex surname |
| 511 | This variable is used to set your ``real name'' on | 517 | This variable is used to set your ``real name'' on IRC. It defaults |
| 512 | IRC. It defaults to the name returned by @code{user-full-name}. If you | 518 | to the name returned by @code{user-full-name}. If you want to hide |
| 513 | want to hide your full name, you might want to set it to some pseudonym. | 519 | your full name, you might want to set it to some pseudonym. |
| 514 | 520 | ||
| 515 | @example | 521 | @example |
| 516 | (setq rcirc-default-user-full-name "Curious Minds Want To Know") | 522 | (setq rcirc-default-user-full-name "Curious Minds Want To Know") |
| @@ -523,10 +529,10 @@ want to hide your full name, you might want to set it to some pseudonym. | |||
| 523 | @cindex nickserv | 529 | @cindex nickserv |
| 524 | @cindex login | 530 | @cindex login |
| 525 | This variable is an alist used to automatically identify yourself on | 531 | This variable is an alist used to automatically identify yourself on |
| 526 | networks. Each sublist starts with a regular expression that is compared | 532 | networks. Each sublist starts with a regular expression that is |
| 527 | to the server address you're connecting to. The second element in the | 533 | compared to the server address you're connecting to. The second |
| 528 | list is a symbol representing the method to use, followed by the | 534 | element in the list is a symbol representing the method to use, |
| 529 | arguments this method requires. | 535 | followed by the arguments this method requires. |
| 530 | 536 | ||
| 531 | Here is an example to illustrate how you would set it: | 537 | Here is an example to illustrate how you would set it: |
| 532 | 538 | ||
| @@ -595,9 +601,9 @@ confuse the Bitlbee account with all the other accounts. | |||
| 595 | @cindex information overload | 601 | @cindex information overload |
| 596 | 602 | ||
| 597 | This is the section of the manual that caters to the busy person | 603 | This is the section of the manual that caters to the busy person |
| 598 | online. There are support channels with several hundred people in | 604 | online. There are support channels with several hundred people in |
| 599 | them. Trying to follow a conversation in these channels can be a | 605 | them. Trying to follow a conversation in these channels can be a |
| 600 | daunting task. This chapters tells you how @code{rcirc} can help. | 606 | daunting task. This chapters tells you how @code{rcirc} can help. |
| 601 | 607 | ||
| 602 | @menu | 608 | @menu |
| 603 | * Channels:: | 609 | * Channels:: |
| @@ -611,6 +617,7 @@ daunting task. This chapters tells you how @code{rcirc} can help. | |||
| 611 | @cindex channels | 617 | @cindex channels |
| 612 | @cindex modeline | 618 | @cindex modeline |
| 613 | 619 | ||
| 620 | @comment This section copied to the Getting started with rcirc section | ||
| 614 | @kindex C-c C-SPC | 621 | @kindex C-c C-SPC |
| 615 | @vindex rcirc-track-minor-mode | 622 | @vindex rcirc-track-minor-mode |
| 616 | @cindex switching channels | 623 | @cindex switching channels |
| @@ -645,22 +652,22 @@ activation of this mode: | |||
| 645 | 652 | ||
| 646 | @cindex busy channels | 653 | @cindex busy channels |
| 647 | If you've joined a very active support channel, tracking activity is | 654 | If you've joined a very active support channel, tracking activity is |
| 648 | no longer useful. The channel will be always active. Switching to | 655 | no longer useful. The channel will be always active. Switching to |
| 649 | active channels using @kbd{C-c C-@key{SPC}} no longer works as | 656 | active channels using @kbd{C-c C-@key{SPC}} no longer works as |
| 650 | expected. | 657 | expected. |
| 651 | 658 | ||
| 652 | @kindex C-c C-l | 659 | @kindex C-c C-l |
| 653 | @cindex low priority channels | 660 | @cindex low priority channels |
| 654 | The solution is to mark this channel as as a low priority channel. | 661 | The solution is to mark this channel as as a low priority channel. |
| 655 | Use @kbd{C-c C-l} to make the current channel a low-priority | 662 | Use @kbd{C-c C-l} to make the current channel a low-priority channel. |
| 656 | channel. Low priority channels have the modeline indicator ``LowPri''. | 663 | Low priority channels have the modeline indicator ``LowPri''. |
| 657 | @kbd{C-c C-@key{SPC}} will not switch to low priority channels unless | 664 | @kbd{C-c C-@key{SPC}} will not switch to low priority channels unless |
| 658 | you use the @kbd{C-u} prefix. | 665 | you use the @kbd{C-u} prefix. |
| 659 | 666 | ||
| 660 | @kindex C-c TAB | 667 | @kindex C-c TAB |
| 661 | @cindex ignored channels | 668 | @cindex ignored channels |
| 662 | If you prefer a channel to never show up in the modeline, then you | 669 | If you prefer a channel to never show up in the modeline, then you |
| 663 | have to ignore it. Use @kbd{C-c @key{TAB}} to ignore the current | 670 | have to ignore it. Use @kbd{C-c @key{TAB}} to ignore the current |
| 664 | channel. | 671 | channel. |
| 665 | 672 | ||
| 666 | @node People, Keywords, Channels, Fighting Information Overload | 673 | @node People, Keywords, Channels, Fighting Information Overload |
| @@ -672,7 +679,7 @@ channel. | |||
| 672 | @cindex trolls | 679 | @cindex trolls |
| 673 | 680 | ||
| 674 | The most important command available to the discerning IRC user is | 681 | The most important command available to the discerning IRC user is |
| 675 | @code{/ignore}. It's the big equalizer online: If people aggravate | 682 | @code{/ignore}. It's the big equalizer online: If people aggravate |
| 676 | you, just ignore them. | 683 | you, just ignore them. |
| 677 | 684 | ||
| 678 | This is of course a crude all-or-nothing solution. Fear not, | 685 | This is of course a crude all-or-nothing solution. Fear not, |
| @@ -704,7 +711,7 @@ obnoxious fellows online. Example: @code{/ignore xah}. | |||
| 704 | This command toggles the bright status of a nick, if you provide one. | 711 | This command toggles the bright status of a nick, if you provide one. |
| 705 | If you don't provide a nick, the command lists all the ``brightened'' | 712 | If you don't provide a nick, the command lists all the ``brightened'' |
| 706 | nicks. All messages by brightened nicks are---you guessed | 713 | nicks. All messages by brightened nicks are---you guessed |
| 707 | it---brightened. Use this for your friends. Example: @code{/bright | 714 | it---brightened. Use this for your friends. Example: @code{/bright |
| 708 | rcy}. | 715 | rcy}. |
| 709 | 716 | ||
| 710 | @item /dim | 717 | @item /dim |
| @@ -715,8 +722,8 @@ rcy}. | |||
| 715 | This command toggles the dim status of a nick, if you provide one. If | 722 | This command toggles the dim status of a nick, if you provide one. If |
| 716 | you don't provide a nick, the command lists all the ``dimmed'' nicks. | 723 | you don't provide a nick, the command lists all the ``dimmed'' nicks. |
| 717 | All messages by dimmed nicks are---you guessed it---dimmed. Use this | 724 | All messages by dimmed nicks are---you guessed it---dimmed. Use this |
| 718 | for boring people and bots. If you are tracking channel activity, | 725 | for boring people and bots. If you are tracking channel activity, |
| 719 | messages by dimmed nicks will not register as activity. Example: | 726 | messages by dimmed nicks will not register as activity. Example: |
| 720 | @code{/dim fsbot}. | 727 | @code{/dim fsbot}. |
| 721 | @end table | 728 | @end table |
| 722 | 729 | ||
| @@ -726,18 +733,18 @@ messages by dimmed nicks will not register as activity. Example: | |||
| 726 | @cindex keywords | 733 | @cindex keywords |
| 727 | 734 | ||
| 728 | On a busy channel, you might want to ignore all activity (using | 735 | On a busy channel, you might want to ignore all activity (using |
| 729 | @kbd{C-c @key{TAB}}) and just watch for certain keywords. The | 736 | @kbd{C-c @key{TAB}}) and just watch for certain keywords. The |
| 730 | following command allows you to highlight certain keywords: | 737 | following command allows you to highlight certain keywords: |
| 731 | 738 | ||
| 732 | @table @code | 739 | @table @code |
| 733 | @item /keyword | 740 | @item /keyword |
| 734 | @cindex /keyword | 741 | @cindex /keyword |
| 735 | This command toggles the highlighting of a keyword, if you provide | 742 | This command toggles the highlighting of a keyword, if you provide |
| 736 | one. If you don't provide a keyword, the current keywords are | 743 | one. If you don't provide a keyword, the current keywords are |
| 737 | listed. Example: @code{/keyword manual}. | 744 | listed. Example: @code{/keyword manual}. |
| 738 | @end table | 745 | @end table |
| 739 | 746 | ||
| 740 | A keyword is regular expression matching a word. Thus, if you add the | 747 | A keyword is regular expression matching a word. Thus, if you add the |
| 741 | keyword @code{wikis?} then this will match the words ``wiki'' and | 748 | keyword @code{wikis?} then this will match the words ``wiki'' and |
| 742 | ``wikis'' but not ``emacswiki''. | 749 | ``wikis'' but not ``emacswiki''. |
| 743 | 750 | ||
| @@ -751,14 +758,14 @@ keyword @code{wikis?} then this will match the words ``wiki'' and | |||
| 751 | @kindex C-c C-o | 758 | @kindex C-c C-o |
| 752 | @cindex low priority channels | 759 | @cindex low priority channels |
| 753 | In busy channels you might not be interested in all the joining, | 760 | In busy channels you might not be interested in all the joining, |
| 754 | parting, quitting, and renaming that goes on. You can omit those | 761 | parting, quitting, and renaming that goes on. You can omit those |
| 755 | notices using @kbd{C-c C-o}. | 762 | notices using @kbd{C-c C-o}. |
| 756 | 763 | ||
| 757 | @vindex rcirc-omit-responses | 764 | @vindex rcirc-omit-responses |
| 758 | @cindex away notices, how to omit | 765 | @cindex away notices, how to omit |
| 759 | You can control which notices get omitted via the | 766 | You can control which notices get omitted via the |
| 760 | @code{rcirc-omit-responses} variable. Here's an example of how to omit | 767 | @code{rcirc-omit-responses} variable. Here's an example of how to |
| 761 | away messages: | 768 | omit away messages: |
| 762 | 769 | ||
| 763 | @example | 770 | @example |
| 764 | (setq rcirc-omit-responses '("JOIN" "PART" "QUIT" "NICK" "AWAY)) | 771 | (setq rcirc-omit-responses '("JOIN" "PART" "QUIT" "NICK" "AWAY)) |
| @@ -766,10 +773,10 @@ away messages: | |||
| 766 | 773 | ||
| 767 | @vindex rcirc-omit-threshold | 774 | @vindex rcirc-omit-threshold |
| 768 | Notice that these messages will not be omitted if the nick in question | 775 | Notice that these messages will not be omitted if the nick in question |
| 769 | has recently been active. After all, you don't want to continue a | 776 | has recently been active. After all, you don't want to continue a |
| 770 | conversation with somebody who just left. That's why @code{rcirc} | 777 | conversation with somebody who just left. That's why @code{rcirc} |
| 771 | checks recent lines in the buffer to figure out if a nick has been | 778 | checks recent lines in the buffer to figure out if a nick has been |
| 772 | active and only omits a message if the nick has not been active. The | 779 | active and only omits a message if the nick has not been active. The |
| 773 | window @code{rcirc} considers is controlled by the | 780 | window @code{rcirc} considers is controlled by the |
| 774 | @code{rcirc-omit-threshold} variable. | 781 | @code{rcirc-omit-threshold} variable. |
| 775 | 782 | ||