aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWilmer van der Gaast <wilmer@gaast.net>2005-11-21 12:53:48 +0100
committerWilmer van der Gaast <wilmer@gaast.net>2005-11-21 12:53:48 +0100
commit689a6e0b8f91eecfc3add9dae769bfcda5a35b77 (patch)
tree5d0693e0d21759579d26e033071631ecb24132e3
parent57db63b585619c2cdaf7627207e3141738d7258d (diff)
Changed all documentation references to the control channel from #bitlbee to &bitlbee.
-rw-r--r--doc/bitlbee.84
-rw-r--r--doc/user-guide/Usage.xml19
-rw-r--r--doc/user-guide/commands.xml4
-rw-r--r--doc/user-guide/quickstart.xml8
4 files changed, 23 insertions, 12 deletions
diff --git a/doc/bitlbee.8 b/doc/bitlbee.8
index 27819a4e..f1d4dbce 100644
--- a/doc/bitlbee.8
+++ b/doc/bitlbee.8
@@ -38,7 +38,7 @@ BitlBee \- IRC gateway to IM chat networks
BitlBee is an IRC daemon that can talk to instant messaging
networks and acts as a gateway. Users can connect to the server
with any normal IRC client and see their 'buddy list' in
-#bitlbee. BitlBee's protocol support is based on the gaim
+&bitlbee. BitlBee's protocol support is based on the gaim
protocol plugins. BitlBee currently supports Oscar (aim and icq),
MSN, Jabber and Yahoo.
@@ -85,7 +85,7 @@ have write permissions in the default location), use this option.
Show help information.
.SH COMMANDS
To get a complete list of commands, please use the \fBhelp commands\fP
-command in the #bitlbee channel.
+command in the &bitlbee channel.
.SH "SEE ALSO"
.BR ircd (8),
.BR inetd (8),
diff --git a/doc/user-guide/Usage.xml b/doc/user-guide/Usage.xml
index 5d87e32b..167a74e0 100644
--- a/doc/user-guide/Usage.xml
+++ b/doc/user-guide/Usage.xml
@@ -13,17 +13,28 @@ it with your favorite irc client. Launch it and connect to localhost port 6667
</sect1>
<sect1>
-<title>The #bitlbee control channel</title>
+<title>The &amp;bitlbee control channel</title>
<para>
Once you are connected to the BitlBee server, you are automatically joined
-to #bitlbee on that server. This channel acts like the 'buddy list' you have
+to &amp;bitlbee on that server. This channel acts like the 'buddy list' you have
on the various other chat networks.
</para>
<para>
-The user 'root' always hangs around in #bitlbee and acts as your interface
-to bitlbee. All commands you give on #bitlbee are 'answered' by root.
+The user 'root' always hangs around in &amp;bitlbee and acts as your interface
+to bitlbee. All commands you give on &amp;bitlbee are 'answered' by root.
+</para>
+
+<para>
+You might be slightly confused by the &amp; in the channel name. This is,
+however, completely allowed by the IRC standards. Just try it on a regular
+IRC server, it should work. The difference between the standard #channels
+and &amp;channels is that the #channels are distributed over all the servers
+on the IRC network, while &amp;channels are local to one server. Because
+the BitlBee control channel is local to one server (and in fact, to one person),
+this name seems more suitable. Also, with this name, it's harder to confuse
+the control channel with the #bitlbee channel on OFTC.
</para>
</sect1>
diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml
index 933fb5b6..b04a6b0a 100644
--- a/doc/user-guide/commands.xml
+++ b/doc/user-guide/commands.xml
@@ -153,7 +153,7 @@
<ircexample>
<ircline nick="ctrlsoft">add 3 gryp@jabber.org grijp</ircline>
- <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>#bitlbee</emphasis></ircaction>
+ <ircaction nick="grijp" hostmask="gryp@jabber.org">has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
</ircexample>
</bitlbee-command>
@@ -356,7 +356,7 @@
<description>
<para>
- Some people prefer themself and root to have operator status in #bitlbee, other people don't. You can change these states using this setting.
+ Some people prefer themself and root to have operator status in &amp;bitlbee, other people don't. You can change these states using this setting.
</para>
<para>
diff --git a/doc/user-guide/quickstart.xml b/doc/user-guide/quickstart.xml
index 9a8b8770..520f240f 100644
--- a/doc/user-guide/quickstart.xml
+++ b/doc/user-guide/quickstart.xml
@@ -6,7 +6,7 @@ Welcome to BitlBee, your IRC gateway to ICQ, MSN, AOL, Jabber and Yahoo Instant
</para>
<para>
-The center of BitlBee is the control channel, <emphasis>#bitlbee</emphasis>. Two users will always be there, <emphasis>you</emphasis> (where "you" is the nickname you are using) and the system user, <emphasis>root</emphasis>.
+The center of BitlBee is the control channel, <emphasis>&amp;bitlbee</emphasis>. Two users will always be there, <emphasis>you</emphasis> (where "you" is the nickname you are using) and the system user, <emphasis>root</emphasis>.
</para>
<para>
@@ -96,7 +96,7 @@ Now you might want to add some contacts, to do this we will use the <emphasis>ad
<ircexample>
<ircline nick="you">add 0 r2d2@example.com</ircline>
- <ircaction nick="r2d2"> has joined <emphasis>#bitlbee</emphasis></ircaction>
+ <ircaction nick="r2d2"> has joined <emphasis>&amp;bitlbee</emphasis></ircaction>
</ircexample>
<para>
@@ -121,7 +121,7 @@ When finished, type <emphasis>help quickstart5</emphasis> to continue.
</para>
<para>
-First of all, a person must be on your contact list for you to chat with them (unless it's a group chat, <emphasis>help groupchats</emphasis> for more). If someone not on your contact list sends you a message, simply add them to the proper account with the <emphasis>add</emphasis> command. Once they are on your list and online, you can chat with them in #bitlbee:
+First of all, a person must be on your contact list for you to chat with them (unless it's a group chat, <emphasis>help groupchats</emphasis> for more). If someone not on your contact list sends you a message, simply add them to the proper account with the <emphasis>add</emphasis> command. Once they are on your list and online, you can chat with them in &amp;bitlbee:
</para>
<ircexample>
@@ -130,7 +130,7 @@ First of all, a person must be on your contact list for you to chat with them (u
</ircexample>
<para>
-If you'd rather chat with them in a separate window use the <emphasis>/msg</emphasis> or <emphasis>/query</emphasis> command, just like you would for a private message in IRC. If you want to have messages automatically come up in private messages rather than in the #bitlbee channel, use the <emphasis>set private</emphasis> command: <emphasis>set private true</emphasis> (<emphasis>set private false</emphasis> to change back).
+If you'd rather chat with them in a separate window use the <emphasis>/msg</emphasis> or <emphasis>/query</emphasis> command, just like you would for a private message in IRC. If you want to have messages automatically come up in private messages rather than in the &amp;bitlbee channel, use the <emphasis>set private</emphasis> command: <emphasis>set private true</emphasis> (<emphasis>set private false</emphasis> to change back).
</para>
<para>