Changeset 52d63dc for doc

Timestamp:

2010-09-04T23:31:47Z (14 years ago)

Author:

Wilmer van der Gaast <wilmer@…>

Branches:

master

Children:

41e0c00

Parents:

4c737ebd

Message:

Slightly better documentation of control channels and groups.

Location:

doc/user-guide

Files:

• commands.xml (modified) (1 diff)
• misc.xml (modified) (1 diff)

doc/user-guide/commands.xml

@@ -1465 +1465 @@
                                 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>

doc/user-guide/misc.xml

@@ -175 +175 @@
 
 <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>