aboutsummaryrefslogtreecommitdiffstats
path: root/doc/user-guide
diff options
context:
space:
mode:
authorWilmer van der Gaast <wilmer@gaast.net>2010-09-05 00:31:47 +0100
committerWilmer van der Gaast <wilmer@gaast.net>2010-09-05 00:31:47 +0100
commit52d63dc804571c63069a7c1e42e8c3f1f2a76527 (patch)
treef70deb3e43c4860fd3e9847a5eb08a93e5fa1e23 /doc/user-guide
parent4c737ebd1a0224d325ee0ab6b3b374861c708452 (diff)
Slightly better documentation of control channels and groups.
Diffstat (limited to 'doc/user-guide')
-rw-r--r--doc/user-guide/commands.xml4
-rw-r--r--doc/user-guide/misc.xml36
2 files changed, 39 insertions, 1 deletions
diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml
index 609ee6fe..6adc4001 100644
--- a/doc/user-guide/commands.xml
+++ b/doc/user-guide/commands.xml
@@ -1464,6 +1464,10 @@
<para>
Only the <emphasis>group list</emphasis> command is supported at the moment, which shows a list of all groups defined so far.
</para>
+
+ <para>
+ If you want to move contacts between groups, you can use the IRC <emphasis>/invite</emphasis> command. Also, if you use the <emphasis>add</emphasis> command in a control channel configured to show just one group, the new contact will automatically be added to that group.
+ </para>
</description>
</bitlbee-command>
diff --git a/doc/user-guide/misc.xml b/doc/user-guide/misc.xml
index dc0ce5ed..979ad026 100644
--- a/doc/user-guide/misc.xml
+++ b/doc/user-guide/misc.xml
@@ -174,7 +174,41 @@ To start a simple group chat, you simply join a channel which a name starting wi
</para>
<para>
-If you want to configure your own channels, you can use the <emphasis>channel set</emphasis>.
+If you want to configure your own channels, you can use the <emphasis>channel set</emphasis> command. See <emphasis>help channels3</emphasis> for more information.
+</para>
+
+</sect1>
+
+<sect1 id="channels3">
+<title>Configuring a control channel</title>
+
+<para>
+The most important setting for a control channel is <emphasis>fill_by</emphasis>. It
+tells BitlBee what information should be used to decide if someone should be shown
+in the channel or not. After setting this setting to, for example, <emphasis>account</emphasis>, you
+also have to set the <emphasis>account</emphasis> setting. Example:
+</para>
+
+<ircexample>
+ <ircline nick="wilmer">chan set &amp;wlm fill_by account</ircline>
+ <ircline nick="root">fill_by = `account'</ircline>
+ <ircline nick="wilmer">chan set &amp;wlm account msn</ircline>
+ <ircline nick="root">account = `msn'</ircline>
+</ircexample>
+
+<para>
+Also, each channel has a <emphasis>show_users</emphasis> setting which lets you
+choose, for example, if you want to see only online contacts in a channel, or
+also/just offline contacts. Example:
+</para>
+
+<ircexample>
+ <ircline nick="wilmer">chan set &amp;offline show_users offline</ircline>
+ <ircline nick="root">show_users = `offline'</ircline>
+</ircexample>
+
+<para>
+See the help information for all these settings for more information.
</para>
</sect1>