aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWilmer van der Gaast <wilmer@gaast.net>2010-06-13 00:40:12 +0200
committerWilmer van der Gaast <wilmer@gaast.net>2010-06-13 00:40:12 +0200
commit12b29dbdce259ad7c65b4b890b5d9a1bd44b60b4 (patch)
tree24ec86c1e50e3b7bb2275e5bf15cb54b4f9a0d0b
parent1c8e5f7fba87b6096a7fd86508ca1821876abb54 (diff)
Small doc update on multi-channel stuff. The "channel" command is not
documented yet.
-rw-r--r--doc/user-guide/help.xml1
-rw-r--r--doc/user-guide/misc.xml46
2 files changed, 47 insertions, 0 deletions
diff --git a/doc/user-guide/help.xml b/doc/user-guide/help.xml
index 7487a841..0684512e 100644
--- a/doc/user-guide/help.xml
+++ b/doc/user-guide/help.xml
@@ -13,6 +13,7 @@ These are the available help subjects:
<variablelist>
<varlistentry><term>quickstart</term><listitem><para>A short introduction into BitlBee</para></listitem></varlistentry>
<varlistentry><term>commands</term><listitem><para>All available commands and settings</para></listitem></varlistentry>
+ <varlistentry><term>channels</term><listitem><para>About creating and customizing channels</para></listitem></varlistentry>
<varlistentry><term>away</term><listitem><para>About setting away states</para></listitem></varlistentry>
<varlistentry><term>smileys</term><listitem><para>A summary of some non-standard smileys you might find and fail to understand</para></listitem></varlistentry>
<varlistentry><term>groupchats</term><listitem><para>How to work with groupchats on BitlBee</para></listitem></varlistentry>
diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml
index 2427ef69..9a0bb67f 100644
--- a/doc/user-guide/misc.xml
+++ b/doc/user-guide/misc.xml
@@ -133,4 +133,50 @@ To restore your logged-in status, you need to either use the <emphasis>register<
</sect1>
+<sect1 id="channels">
+<title>Dealing with channels</title>
+
+<para>
+You can have as many channels in BitlBee as you want. You maintain your channel list using the <emphasis>channel</emphasis> command. You can create new channels by just joining them, like on regular IRC networks.
+</para>
+
+<para>
+You can create two kinds of channels. Control channels, and groupchat channels. By default, BitlBee will set up new channels as control channels if their name starts with an &amp;, and as chat channels if it starts with a #.
+</para>
+
+<para>
+Control channels are where you see your contacts. By default, you will have one control channel called &amp;bitlbee, containing all your contacts. But you can create more, if you want, and divide your contact list accross several channels.
+</para>
+
+<para>
+For example, you can have one channel with all contacts from your MSN Messenger account in it. Or all contacts from the group called "Work".
+</para>
+
+<para>
+Type <emphasis>help channels2</emphasis> to read more.
+</para>
+
+</sect1>
+
+<sect1 id="channels2">
+<title>Creating a channel</title>
+
+<para>
+When you create a new channel, BitlBee will try to guess from its name which contacts to fill it with. For example, if the channel name (excluding the &amp;) matches the name of a group in which you have one or more contacts, the channel will contain all those contacts.
+</para>
+
+<para>
+Any valid account ID (so a number, protocol name or part of screenname, as long as it's unique) can also be used as a channel name. So if you just join &amp;msn, it will contain all your MSN contacts (as long as you have only one MSN account set up). And if you have a Facebook account set up, you can see its contacts by just joining &amp;facebook.
+</para>
+
+<para>
+To start a simple group chat, you simply join a channel which a name starting with #, and invite people into it. All people you invite have to be on the same IM network and contact list.
+</para>
+
+<para>
+If you want to configure your own channels, you can use the <emphasis>channel set</emphasis>.
+</para>
+
+</sect1>
+
</chapter>