Changes in doc/user-guide/commands.xml [4c73ba62:a5c6ebd]

File:

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

doc/user-guide/commands.xml

@@ -69 +69 @@
                         
                         <bitlbee-command name="twitter">
-                                <syntax>account add twitter &lt;handle&gt; [&lt;password&gt;]</syntax>
+                                <syntax>account add twitter &lt;handle&gt;</syntax>
 
                                 <description>
@@ -95 +95 @@
                         
                         <bitlbee-command name="identica">
-                                <syntax>account add identica &lt;handle&gt; [&lt;password&gt;]</syntax>
+                                <syntax>account add identica &lt;handle&gt;</syntax>
 
                                 <description>
                                         <para>
-                                                Same protocol as <emphasis>twitter</emphasis>, but defaults to a <emphasis>base_url</emphasis> pointing at identi.ca, and with OAuth disabled.
+                                                Same protocol as <emphasis>twitter</emphasis>, but defaults to a <emphasis>base_url</emphasis> pointing at identi.ca. It also works with OAuth (so don't specify your password).
                                         </para>
                                 </description>
@@ -835 +835 @@
         <bitlbee-setting name="commands" type="boolean" scope="account">
                 <default>true</default>
+                <possible-values>true, false, strict</possible-values>
 
                 <description>
@@ -848 +849 @@
                                 <varlistentry><term>follow &lt;screenname&gt;</term><listitem><para>Start following a person</para></listitem></varlistentry>
                                 <varlistentry><term>unfollow &lt;screenname&gt;</term><listitem><para>Stop following a person</para></listitem></varlistentry>
+                                <varlistentry><term>favourite &lt;screenname|#id&gt;</term><listitem><para>Favo<emphasis>u</emphasis>rite the given user's most recent tweet, or the given tweet ID.</para></listitem></varlistentry>
                                 <varlistentry><term>post &lt;message&gt;</term><listitem><para>Post a tweet</para></listitem></varlistentry>
                         </variablelist>
 
                         <para>
-                                Anything that doesn't look like a command will be treated as a tweet. Watch out for typos! :-)
+                                Anything that doesn't look like a command will be treated as a tweet. Watch out for typos, or to avoid this behaviour, you can set this setting to <emphasis>strict</emphasis>, which causes the <emphasis>post</emphasis> command to become mandatory for posting a tweet.
                         </para>
                 </description>
@@ -928 +930 @@
                         
                         <para>
+                                With a ! prefix an inverted channel can be created, for example with this setting set to <emphasis>!group</emphasis> you can create a channel with all users <emphasis>not</emphasis> in that group.
+                        </para>
+                        
+                        <para>
                                 Note that, when creating a new channel, BitlBee will try to preconfigure the channel for you, based on the channel name. See <emphasis>help channels</emphasis>.
                         </para>
@@ -1022 +1028 @@
 
         </bitlbee-setting>
+
+        <bitlbee-setting name="stream" type="boolean" scope="account">
+                <default>true</default>
+
+                <description>
+                        <para>
+                                For Twitter accounts, this setting enables use of the Streaming API. This automatically gives you incoming DMs as well.
+                        </para>
+                        
+                        <para>
+                                For other Twitter-like services, this setting is not supported.
+                        </para>
+                </description>
+
+        </bitlbee-setting>
         
         <bitlbee-setting name="target_url_length" type="integer" scope="account">
@@ -1337 +1358 @@
 
         <bitlbee-setting name="show_ids" type="boolean" scope="account">
-                <default>false</default>
+                <default>true</default>
 
                 <description>
@@ -1501 +1522 @@
 
         <bitlbee-setting name="tls" type="boolean" scope="account">
-                <default>try</default>
-
-                <description>
-                        <para>
-                                Newer Jabber servers allow clients to convert a plain-text session to a TLS/SSL-encrypted session. Normally (with this setting set to <emphasis>try</emphasis>) BitlBee will do this, if possible.
-                        </para>
-
-                        <para>
-                                If you want to force BitlBee to use TLS sessions only (and to give up if that doesn't seem to be possible) you can set this setting to <emphasis>true</emphasis>. Set it to <emphasis>false</emphasis> if you want the session to remain plain-text.
+                <default>true</default>
+
+                <description>
+                        <para>
+                                By default (with this setting enabled), BitlBee will require Jabber servers to offer encryption via StartTLS and refuse to connect if they don't.
+                        </para>
+
+                        <para>
+                                If you set this to "try", BitlBee will use StartTLS only if it's offered. With the setting disabled, StartTLS support will be ignored and avoided entirely.
                         </para>
                 </description>
@@ -1767 +1788 @@
         <bitlbee-command name="group">
                 <short-description>Contact group management</short-description>
-                <syntax>group list</syntax>
-
-                <description>
-                        <para>
-                                Only the <emphasis>group list</emphasis> command is supported at the moment, which shows a list of all groups defined so far.
+                <syntax>group [ list | info &lt;group&gt; ]</syntax>
+
+                <description>
+                        <para>
+                                The <emphasis>group list</emphasis> command shows a list of all groups defined so far.
+                        </para>
+                        
+                        <para>
+                                The <emphasis>group info</emphasis> command shows a list of all members of a the group &lt;group&gt;.
                         </para>