Changeset 975708a for doc

Timestamp:

2010-09-05T12:08:12Z (14 years ago)

Author:

Wilmer van der Gaast <wilmer@…>

Branches:

master

Children:

2c6b0f4

Parents:

4e1be76 (diff), ed320e8 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Mainline merge.

Location:

doc/user-guide

Files:

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

doc/user-guide/commands.xml

@@ -73 +73 @@
                                         
                                         <para>
-                                                By default all your Twitter contacts will come from a contact called twitter_(yourusername). You can change this behaviour using the <emphasis>mode</emphasis> setting (see <emphasis>help set mode</emphasis>).
+                                                By default all your Twitter contacts will appear in a new channel called #twitter_yourusername. You can change this behaviour using the <emphasis>mode</emphasis> setting (see <emphasis>help set mode</emphasis>).
                                         </para>
                                         
@@ -811 +811 @@
         <bitlbee-setting name="mode" type="string" scope="account">
                 <possible-values>one, many, chat</possible-values>
-                <default>one</default>
-
-                <description>
-                        <para>
-                                By default, everything from the Twitter module will come from one nick, twitter_(yourusername). If you prefer to have individual nicks for everyone, you can set this setting to "many" instead.
-                        </para>
-                        
-                        <para>
-                                If you prefer to have all your Twitter things in a separate channel, you can set this setting to "chat".
-                        </para>
-                        
-                        <para>
-                                In the last two modes, you can send direct messages by /msg'ing your contacts directly. Note, however, that incoming DMs are not fetched yet.
+                <default>chat</default>
+
+                <description>
+                        <para>
+                                By default, BitlBee will create a separate channel (called #twitter_yourusername) for all your Twitter contacts/messages.
+                        </para>
+
+                        <para>
+                                If you don't want an extra channel, you can set this setting to "one" (everything will come from one nick, twitter_yourusername), or to "many" (individual nicks for everyone).
+                        </para>
+                        
+                        <para>
+                                With modes "chat" and "many", you can send direct messages by /msg'ing your contacts directly. Note, however, that incoming DMs are not fetched yet.
+                        </para>
+                        
+                        <para>
+                                With modes "many" and "one", you can post tweets by /msg'ing the twitter_yourusername contact. In mode "chat", messages posted in the Twitter channel will also be posted as tweets.
                         </para>
                 </description>
@@ -1461 +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>