Merge from emacs-24; up to 2012-12-06T01:39:03Z!monnier@iro.umontreal.ca

[bpt/emacs.git] / doc / misc / rcirc.texi

diff --git a/doc/misc/rcirc.texi b/doc/misc/rcirc.texi
index 01e86fb..3bce0c7 100644 (file)
--- a/doc/misc/rcirc.texi
+++ b/doc/misc/rcirc.texi
@@ -5,25 +5,24 @@
 @c %**end of header
 
 @copying
 @c %**end of header
 
 @copying

-Copyright @copyright{} 2006, 2007, 2008 Free Software Foundation, Inc.
+Copyright @copyright{} 2006--2013 Free Software Foundation, Inc.

 
 @quotation
 Permission is granted to copy, distribute and/or modify this document
 
 @quotation
 Permission is granted to copy, distribute and/or modify this document

-under the terms of the GNU Free Documentation License, Version 1.2 or
+under the terms of the GNU Free Documentation License, Version 1.3 or

 any later version published by the Free Software Foundation; with no
 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
 and with the Back-Cover Texts as in (a) below.  A copy of the license is
 included in the section entitled ``GNU Free Documentation License''.
 
 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
 any later version published by the Free Software Foundation; with no
 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
 and with the Back-Cover Texts as in (a) below.  A copy of the license is
 included in the section entitled ``GNU Free Documentation License''.
 
 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and

-modify this GNU manual.  Buying copies from the FSF supports it in
-developing GNU and promoting software freedom.''
+modify this GNU manual.''

 @end quotation
 @end copying
 
 @end quotation
 @end copying
 

-@dircategory Emacs
+@dircategory Emacs network features

 @direntry
 @direntry

-* Rcirc: (rcirc).       Internet Relay Chat (IRC) client.
+* Rcirc: (rcirc).               Internet Relay Chat (IRC) client.

 @end direntry
 
 @titlepage
 @end direntry
 
 @titlepage


@@ -33,10 +32,11 @@ developing GNU and promoting software freedom.''
 @insertcopying
 @end titlepage
 
 @insertcopying
 @end titlepage
 

+@contents
+

 @ifnottex
 @ifnottex

-@node Top, Basics, (dir), (dir)
+@node Top

 @top rcirc Manual
 @top rcirc Manual

-@end ifnottex

 
 @code{rcirc} is an Emacs IRC client.
 
 
 @code{rcirc} is an Emacs IRC client.
 


@@ -45,6 +45,10 @@ communicate with each other in real-time.  Communication occurs both in
 topic channels which are collections of many users, or privately, with
 just one other user.
 
 topic channels which are collections of many users, or privately, with
 just one other user.
 

+@insertcopying
+
+@end ifnottex
+

 @menu
 * Basics::
 * Reference::
 @menu
 * Basics::
 * Reference::


@@ -88,7 +92,7 @@ Hacking and Tweaking
 @end detailmenu
 @end menu
 
 @end detailmenu
 @end menu
 

-@node Basics, Reference, Top, Top
+@node Basics

 @chapter Basics
 
 This chapter contains a brief introduction to IRC (Internet Relay Chat),
 @chapter Basics
 
 This chapter contains a brief introduction to IRC (Internet Relay Chat),


@@ -99,7 +103,7 @@ and a quick tutorial on @code{rcirc}.
 * Getting started with rcirc::
 @end menu
 
 * Getting started with rcirc::
 @end menu
 

-@node Internet Relay Chat, Getting started with rcirc, Basics, Basics
+@node Internet Relay Chat

 @section Internet Relay Chat
 @cindex internet relay chat
 @cindex irc
 @section Internet Relay Chat
 @cindex internet relay chat
 @cindex irc


@@ -152,7 +156,7 @@ deego: fsbot rules!
 @kindex TAB
 Since this is so common, you can use @key{TAB} to do nick completion.
 
 @kindex TAB
 Since this is so common, you can use @key{TAB} to do nick completion.
 

-@node Getting started with rcirc, , Internet Relay Chat, Basics
+@node Getting started with rcirc

 @section Getting started with rcirc
 @cindex getting started
 @cindex connecting to a server
 @section Getting started with rcirc
 @cindex getting started
 @cindex connecting to a server


@@ -161,7 +165,7 @@ Since this is so common, you can use @key{TAB} to do nick completion.
 Use the command @kbd{M-x irc} to connect using the defaults.
 @xref{Configuration}, if you want to change the defaults.
 
 Use the command @kbd{M-x irc} to connect using the defaults.
 @xref{Configuration}, if you want to change the defaults.
 

-Use @kbd{C-u M-x irc} if you don't want to use the defaults, eg. if you
+Use @kbd{C-u M-x irc} if you don't want to use the defaults, e.g., if you

 want to connect to a different network, or connect to the same network
 using a different nick.  This will prompt you for four things:
 
 want to connect to a different network, or connect to the same network
 using a different nick.  This will prompt you for four things:
 


@@ -241,7 +245,7 @@ To make this permanent, add the following to your init file:
 
 Use @kbd{C-c C-@key{SPC}} to switch to these buffers.
 
 
 Use @kbd{C-c C-@key{SPC}} to switch to these buffers.
 

-@node Reference, Fighting Information Overload, Basics, Top
+@node Reference

 @chapter Reference
 @cindex reference
 
 @chapter Reference
 @cindex reference
 


@@ -255,7 +259,7 @@ documentation.
 * Configuration::
 @end menu
 
 * Configuration::
 @end menu
 

-@node rcirc commands, Useful IRC commands, Reference, Reference
+@node rcirc commands

 @section rcirc commands
 @cindex rcirc commands
 @cindex commands
 @section rcirc commands
 @cindex rcirc commands
 @cindex commands


@@ -398,7 +402,7 @@ buffer, you automatically quit the server and part all channels.  (Also
 @code{/quit ZZZzzz...}.)
 @end table
 
 @code{/quit ZZZzzz...}.)
 @end table
 

-@node Useful IRC commands, Configuration, rcirc commands, Reference
+@node Useful IRC commands

 @section Useful IRC commands
 @cindex irc commands
 @cindex commands
 @section Useful IRC commands
 @cindex irc commands
 @cindex commands


@@ -426,7 +430,7 @@ about the fantastic world of IRC online at
 @uref{http://www.irchelp.org/, the Internet Relay Chat (IRC) help
 archive}.
 
 @uref{http://www.irchelp.org/, the Internet Relay Chat (IRC) help
 archive}.
 

-@node Configuration, , Useful IRC commands, Reference
+@node Configuration

 @section Configuration
 @cindex configuring rcirc
 
 @section Configuration
 @cindex configuring rcirc
 


@@ -503,22 +507,22 @@ This variable contains the default user name to report to the server.
 It defaults to the login name returned by @code{user-login-name}, just
 like @code{rcirc-default-nick}.
 
 It defaults to the login name returned by @code{user-login-name}, just
 like @code{rcirc-default-nick}.
 

-@item rcirc-default-user-full-name
-@vindex rcirc-default-user-full-name
+@item rcirc-default-full-name
+@vindex rcirc-default-full-name

 @cindex full name
 @cindex real name
 @cindex surname
 @cindex full name
 @cindex real name
 @cindex surname

-This variable is used to set your ``real name'' on IRC.  It defaults
+This variable is used to set your ``real name'' on IRC@.  It defaults

 to the name returned by @code{user-full-name}.  If you want to hide
 your full name, you might want to set it to some pseudonym.
 
 @example
 to the name returned by @code{user-full-name}.  If you want to hide
 your full name, you might want to set it to some pseudonym.
 
 @example

-(setq rcirc-default-user-full-name "Curious Minds Want To Know")
+(setq rcirc-default-full-name "Curious Minds Want To Know")

 @end example
 
 @item rcirc-authinfo
 @vindex rcirc-authinfo
 @end example
 
 @item rcirc-authinfo
 @vindex rcirc-authinfo

-@cindex authentification
+@cindex authentication

 @cindex identification
 @cindex nickserv
 @cindex login
 @cindex identification
 @cindex nickserv
 @cindex login


@@ -541,7 +545,7 @@ And here are the valid method symbols and the arguments they require:
 
 @table @code
 @item nickserv
 
 @table @code
 @item nickserv

-@cindex nickserv authentification
+@cindex nickserv authentication

 Use this symbol if you need to identify yourself as follows when
 connecting to a network: @code{/msg nickserv identify secret}.  The
 necessary arguments are the nickname you want to use this for, and the
 Use this symbol if you need to identify yourself as follows when
 connecting to a network: @code{/msg nickserv identify secret}.  The
 necessary arguments are the nickname you want to use this for, and the


@@ -552,7 +556,7 @@ pick a password for it.  Contact @code{nickserv} and check out the
 details.  (Using @code{/msg nickserv help}, for example.)
 
 @item chanserv
 details.  (Using @code{/msg nickserv help}, for example.)
 
 @item chanserv

-@cindex chanserv authentification
+@cindex chanserv authentication

 Use this symbol if you need to identify yourself as follows if you want
 to join a particular channel: @code{/msg chanserv identify #underground
 secret}.  The necessary arguments are the nickname and channel you want
 Use this symbol if you need to identify yourself as follows if you want
 to join a particular channel: @code{/msg chanserv identify #underground
 secret}.  The necessary arguments are the nickname and channel you want


@@ -563,7 +567,7 @@ the password to use.  Contact @code{chanserv} and check out the details.
 (Using @code{/msg chanserv help}, for example.)
 
 @item bitlbee
 (Using @code{/msg chanserv help}, for example.)
 
 @item bitlbee

-@cindex bitlbee authentification
+@cindex bitlbee authentication

 Use this symbol if you need to identify yourself in the Bitlbee channel
 as follows: @code{identify secret}.  The necessary arguments are the
 nickname you want to use this for, and the password to use.
 Use this symbol if you need to identify yourself in the Bitlbee channel
 as follows: @code{identify secret}.  The necessary arguments are the
 nickname you want to use this for, and the password to use.


@@ -579,7 +583,7 @@ Bitlbee acts like an IRC server, but in fact it is a gateway to a lot of
 other instant messaging services.  You can either install Bitlbee
 locally or use a public Bitlbee server.  There, you need to create an
 account with a password.  This is the nick and password you need to
 other instant messaging services.  You can either install Bitlbee
 locally or use a public Bitlbee server.  There, you need to create an
 account with a password.  This is the nick and password you need to

-provide for the bitlbee authentification method.
+provide for the bitlbee authentication method.

 
 Later, you will tell Bitlbee about your accounts and passwords on all
 the other instant messaging services, and Bitlbee will log you in.  All
 
 Later, you will tell Bitlbee about your accounts and passwords on all
 the other instant messaging services, and Bitlbee will log you in.  All


@@ -590,7 +594,7 @@ confuse the Bitlbee account with all the other accounts.
 
 @end table
 
 
 @end table
 

-@node Fighting Information Overload, Hacking and Tweaking, Reference, Top
+@node Fighting Information Overload

 @chapter Fighting Information Overload
 @cindex information overload
 
 @chapter Fighting Information Overload
 @cindex information overload
 


@@ -606,7 +610,7 @@ daunting task.  This chapters tells you how @code{rcirc} can help.
 * Notices::
 @end menu
 
 * Notices::
 @end menu
 

-@node Channels, People, Fighting Information Overload, Fighting Information Overload
+@node Channels

 @section Channels
 @cindex channels
 @cindex modeline
 @section Channels
 @cindex channels
 @cindex modeline


@@ -652,7 +656,7 @@ expected.
 
 @kindex C-c C-l
 @cindex low priority channels
 
 @kindex C-c C-l
 @cindex low priority channels

-The solution is to mark this channel as as a low priority channel.
+The solution is to mark this channel as a low priority channel.

 Use @kbd{C-c C-l} to make the current channel a low-priority channel.
 Low priority channels have the modeline indicator ``LowPri''.
 @kbd{C-c C-@key{SPC}} will not switch to low priority channels unless
 Use @kbd{C-c C-l} to make the current channel a low-priority channel.
 Low priority channels have the modeline indicator ``LowPri''.
 @kbd{C-c C-@key{SPC}} will not switch to low priority channels unless


@@ -664,7 +668,7 @@ If you prefer a channel to never show up in the modeline, then you
 have to ignore it.  Use @kbd{C-c @key{TAB}} to ignore the current
 channel.
 
 have to ignore it.  Use @kbd{C-c @key{TAB}} to ignore the current
 channel.
 

-@node People, Keywords, Channels, Fighting Information Overload
+@node People

 @section People
 @cindex people, how to ignore
 @cindex nicks, how to ignore
 @section People
 @cindex people, how to ignore
 @cindex nicks, how to ignore


@@ -722,7 +726,7 @@ messages by dimmed nicks will not register as activity.  Example:
 @end table
 
 
 @end table
 
 

-@node Keywords, Notices, People, Fighting Information Overload
+@node Keywords

 @section Keywords
 @cindex keywords
 
 @section Keywords
 @cindex keywords
 


@@ -738,9 +742,9 @@ one.  If you don't provide a keyword, the current keywords are
 listed.  Example: @code{/keyword manual}.
 @end table
 
 listed.  Example: @code{/keyword manual}.
 @end table
 

-@node Notices, , Keywords, Fighting Information Overload
+@node Notices

 @section Notices
 @section Notices

-@cindex part notices, how to omit 
+@cindex part notices, how to omit

 @cindex join notices, how to omit
 @cindex quit notices, how to omit
 @cindex nick notices, how to omit
 @cindex join notices, how to omit
 @cindex quit notices, how to omit
 @cindex nick notices, how to omit


@@ -758,7 +762,7 @@ You can control which notices get omitted via the
 omit away messages:
 
 @example
 omit away messages:
 
 @example

-(setq rcirc-omit-responses '("JOIN" "PART" "QUIT" "NICK" "AWAY))
+(setq rcirc-omit-responses '("JOIN" "PART" "QUIT" "NICK" "AWAY"))

 @end example
 
 @vindex rcirc-omit-threshold
 @end example
 
 @vindex rcirc-omit-threshold


@@ -770,7 +774,7 @@ active and only omits a message if the nick has not been active.  The
 window @code{rcirc} considers is controlled by the
 @code{rcirc-omit-threshold} variable.
 
 window @code{rcirc} considers is controlled by the
 @code{rcirc-omit-threshold} variable.
 

-@node Hacking and Tweaking, GNU Free Documentation License, Fighting Information Overload, Top
+@node Hacking and Tweaking

 @chapter Hacking and Tweaking
 @cindex hacking and tweaking
 
 @chapter Hacking and Tweaking
 @cindex hacking and tweaking
 


@@ -785,7 +789,7 @@ Here are some examples of stuff you can do to configure @code{rcirc}.
 * Reconnecting after you have lost the connection::
 @end menu
 
 * Reconnecting after you have lost the connection::
 @end menu
 

-@node Skipping /away messages using handlers, Using fly spell mode, Hacking and Tweaking, Hacking and Tweaking
+@node Skipping /away messages using handlers

 @section Skipping @code{/away} messages using handlers
 @cindex /away messages
 
 @section Skipping @code{/away} messages using handlers
 @cindex /away messages
 


@@ -805,7 +809,7 @@ require @code{rcirc} before defining the handler:
   "/away message handler.")
 @end example
 
   "/away message handler.")
 @end example
 

-@node Using fly spell mode, Scrolling conservatively, Skipping /away messages using handlers, Hacking and Tweaking
+@node Using fly spell mode

 @section Using fly spell mode
 @cindex fly spell
 @cindex spelling
 @section Using fly spell mode
 @cindex fly spell
 @cindex spelling


@@ -824,7 +828,7 @@ for @code{rcirc} buffers:
 @xref{Spelling, , Flyspell mode, emacs, The GNU Emacs Manual},
 for details.
 
 @xref{Spelling, , Flyspell mode, emacs, The GNU Emacs Manual},
 for details.
 

-@node Scrolling conservatively, Changing the time stamp format, Using fly spell mode, Hacking and Tweaking
+@node Scrolling conservatively

 @section Scrolling conservatively
 @cindex input line
 @cindex scrolling
 @section Scrolling conservatively
 @cindex input line
 @cindex scrolling


@@ -846,7 +850,7 @@ window when possible.  The following snippet uses a local value for
 @xref{Scrolling, , Scrolling conservatively, emacs, The GNU Emacs
 Manual}, for details.
 
 @xref{Scrolling, , Scrolling conservatively, emacs, The GNU Emacs
 Manual}, for details.
 

-@node Changing the time stamp format, Defining a new command, Scrolling conservatively, Hacking and Tweaking
+@node Changing the time stamp format

 @section Changing the time stamp format
 @cindex time stamp
 @cindex date time
 @section Changing the time stamp format
 @cindex time stamp
 @cindex date time


@@ -860,7 +864,7 @@ how to include the date in the time stamp:
 (setq rcirc-time-format "%Y-%m-%d %H:%M ")
 @end example
 
 (setq rcirc-time-format "%Y-%m-%d %H:%M ")
 @end example
 

-@node Defining a new command, Reconnecting after you have lost the connection, Changing the time stamp format, Hacking and Tweaking
+@node Defining a new command

 @section Defining a new command
 @cindex defining commands
 @cindex commands, defining
 @section Defining a new command
 @cindex defining commands
 @cindex commands, defining


@@ -883,7 +887,7 @@ because @code{defun-rcirc-command} is not yet available, and without
                          (concat "I use " rcirc-id-string))))
 @end smallexample
 
                          (concat "I use " rcirc-id-string))))
 @end smallexample
 

-@node Reconnecting after you have lost the connection, , Defining a new command, Hacking and Tweaking
+@node Reconnecting after you have lost the connection

 @section Reconnecting after you have lost the connection
 @cindex reconnecting
 @cindex disconnecting servers, reconnecting
 @section Reconnecting after you have lost the connection
 @cindex reconnecting
 @cindex disconnecting servers, reconnecting


@@ -894,7 +898,7 @@ client doesn't realize that it has been disconnected.  It takes several
 minutes until the client decides that the connection has in fact been
 lost.  The simple solution is to use @kbd{M-x rcirc}.  The problem is
 that this opens an @emph{additional} connection, so you'll have two
 minutes until the client decides that the connection has in fact been
 lost.  The simple solution is to use @kbd{M-x rcirc}.  The problem is
 that this opens an @emph{additional} connection, so you'll have two

-copies of every channel buffer --- one dead and one live.
+copies of every channel buffer, one dead and one live.

 
 The real answer, therefore, is a @code{/reconnect} command:
 
 
 The real answer, therefore, is a @code{/reconnect} command:
 


@@ -920,29 +924,25 @@ The real answer, therefore, is a @code{/reconnect} command:
        (delete-process process)
        (rcirc-connect server port nick
                       rcirc-default-user-name
        (delete-process process)
        (rcirc-connect server port nick
                       rcirc-default-user-name

-                      rcirc-default-user-full-name
+                      rcirc-default-full-name

                       channels))))
 @end smallexample
 
                       channels))))
 @end smallexample
 

-@node GNU Free Documentation License, Key Index, Hacking and Tweaking, Top
+@node GNU Free Documentation License

 @appendix GNU Free Documentation License
 @include doclicense.texi
 
 
 @appendix GNU Free Documentation License
 @include doclicense.texi
 
 

-@node Key Index, Variable Index, GNU Free Documentation License, Top
+@node Key Index

 @unnumbered Key Index
 @printindex ky
 
 @unnumbered Key Index
 @printindex ky
 

-@node Variable Index, Index, Key Index, Top
+@node Variable Index

 @unnumbered Variable Index
 @printindex vr
 
 @unnumbered Variable Index
 @printindex vr
 

-@node Index, , Variable Index, Top
+@node Index

 @unnumbered Index
 @printindex cp
 
 @bye
 @unnumbered Index
 @printindex cp
 
 @bye

-
-@ignore
-   arch-tag: 2589e562-3843-4ffc-8c2f-477cbad57c01
-@end ignore