Changeset f5c0d8e for doc/user-guide

Timestamp:

2010-08-31T20:06:14Z (14 years ago)

Author:

Wilmer van der Gaast <wilmer@…>

Branches:

master

Children:

0c85c08

Parents:

8358691 (diff), 31dbb90a (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:

Merge mainline stuff.

File:

• doc/user-guide/commands.xml (modified) (7 diffs)

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>
                                         
@@ -970 +970 @@
         <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>
@@ -1637 +1641 @@
         </bitlbee-command>
         
-        <bitlbee-command name="transfers">
+        <bitlbee-command name="transfer">
                 <short-description>Monitor, cancel, or reject file transfers</short-description>
-                <syntax>transfers [&lt;cancel&gt; id | &lt;reject&gt;]</syntax>
+                <syntax>transfer [&lt;cancel&gt; id | &lt;reject&gt;]</syntax>
                 
                 <description>
                         <para>
-                                Without parameters the currently pending file transfers and their status will be listed. Available actions are <emphasis>cancel</emphasis> and <emphasis>reject</emphasis>. See <emphasis>help transfers &lt;action&gt;</emphasis> for more information.
+                                Without parameters the currently pending file transfers and their status will be listed. Available actions are <emphasis>cancel</emphasis> and <emphasis>reject</emphasis>. See <emphasis>help transfer &lt;action&gt;</emphasis> for more information.
                         </para>
 
                         <ircexample>
-                                <ircline nick="ulim">transfers</ircline>
+                                <ircline nick="ulim">transfer</ircline>
                         </ircexample>
                 </description>
@@ -1653 +1657 @@
                 <bitlbee-command name="cancel">
                         <short-description>Cancels the file transfer with the given id</short-description>
-                        <syntax>transfers &lt;cancel&gt; id</syntax>
+                        <syntax>transfer &lt;cancel&gt; id</syntax>
 
                         <description>
@@ -1660 +1664 @@
 
                         <ircexample>
-                                <ircline nick="ulim">transfers cancel 1</ircline>
+                                <ircline nick="ulim">transfer cancel 1</ircline>
                                 <ircline nick="root">Canceling file transfer for test</ircline>
                         </ircexample>
@@ -1667 +1671 @@
                 <bitlbee-command name="reject">
                         <short-description>Rejects all incoming transfers</short-description>
-                        <syntax>transfers &lt;reject&gt;</syntax>
+                        <syntax>transfer &lt;reject&gt;</syntax>
 
                         <description>
@@ -1674 +1678 @@
 
                         <ircexample>
-                                <ircline nick="ulim">transfers reject</ircline>
+                                <ircline nick="ulim">transfer reject</ircline>
                         </ircexample>
                 </bitlbee-command>