Changeset 52d63dc for doc


Ignore:
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:
2 edited

Legend:

Unmodified
Added
Removed
  • doc/user-guide/commands.xml

    r4c737ebd r52d63dc  
    14651465                                Only the <emphasis>group list</emphasis> command is supported at the moment, which shows a list of all groups defined so far.
    14661466                        </para>
     1467                       
     1468                        <para>
     1469                                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.
     1470                        </para>
    14671471                </description>
    14681472        </bitlbee-command>
  • doc/user-guide/misc.xml

    r4c737ebd r52d63dc  
    175175
    176176<para>
    177 If you want to configure your own channels, you can use the <emphasis>channel set</emphasis>.
     177If you want to configure your own channels, you can use the <emphasis>channel set</emphasis> command. See <emphasis>help channels3</emphasis> for more information.
     178</para>
     179
     180</sect1>
     181
     182<sect1 id="channels3">
     183<title>Configuring a control channel</title>
     184
     185<para>
     186The most important setting for a control channel is <emphasis>fill_by</emphasis>. It
     187tells BitlBee what information should be used to decide if someone should be shown
     188in the channel or not. After setting this setting to, for example, <emphasis>account</emphasis>, you
     189also have to set the <emphasis>account</emphasis> setting. Example:
     190</para>
     191
     192<ircexample>
     193        <ircline nick="wilmer">chan set &amp;wlm fill_by account</ircline>
     194        <ircline nick="root">fill_by = `account'</ircline>
     195        <ircline nick="wilmer">chan set &amp;wlm account msn</ircline>
     196        <ircline nick="root">account = `msn'</ircline>
     197</ircexample>
     198
     199<para>
     200Also, each channel has a <emphasis>show_users</emphasis> setting which lets you
     201choose, for example, if you want to see only online contacts in a channel, or
     202also/just offline contacts. Example:
     203</para>
     204
     205<ircexample>
     206        <ircline nick="wilmer">chan set &amp;offline show_users offline</ircline>
     207        <ircline nick="root">show_users = `offline'</ircline>
     208</ircexample>
     209
     210<para>
     211See the help information for all these settings for more information.
    178212</para>
    179213
Note: See TracChangeset for help on using the changeset viewer.