Changes in doc/user-guide/commands.xml [cd428e4:eded1f7]

File:

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

doc/user-guide/commands.xml

@@ -17 +17 @@
 
                 <bitlbee-command name="add">
-                        <syntax>account add &lt;protocol&gt; &lt;username&gt; &lt;password&gt; [&lt;server&gt;]</syntax>
+                        <syntax>account add &lt;protocol&gt; &lt;username&gt; &lt;password&gt;</syntax>
 
                         <description>
@@ -26 +26 @@
                         
                         <bitlbee-command name="jabber">
-                                <syntax>account add jabber &lt;handle@server.tld&gt; &lt;password&gt; [&lt;servertag&gt;]</syntax>
+                                <syntax>account add jabber &lt;handle@server.tld&gt; &lt;password&gt;</syntax>
 
                                 <description>
@@ -50 +50 @@
                         
                         <bitlbee-command name="oscar">
-                                <syntax>account add oscar &lt;handle&gt; &lt;password&gt; [&lt;servername&gt;]</syntax>
+                                <syntax>account add oscar &lt;handle&gt; &lt;password&gt;</syntax>
 
                                 <description>
                                         <para>
-                                                Specifying a server is required for OSCAR, since OSCAR can be used for both ICQ- and AIM-connections. Although these days it's supposed to be possible to connect to ICQ via AIM-servers and vice versa, we like to stick with this separation for now. For ICQ connections, the servername is <emphasis>login.icq.com</emphasis>, for AIM connections it's <emphasis>login.oscar.aol.com</emphasis>.
+                                                OSCAR is the protocol used to connect to AIM and/or ICQ. The servers will automatically detect if you're using a numeric or non-numeric username so there's no need to tell which network you want to connect to.
                                         </para>
                                 </description>
 
                                 <ircexample>
-                                        <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw login.icq.com</ircline>
+                                        <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw</ircline>
                                         <ircline nick="root">Account successfully added</ircline>
                                 </ircexample>
@@ -595 +595 @@
                 <description>
                         <para>
-                                Can be set for Jabber- and OSCAR-connections. For OSCAR, this must be set to <emphasis>login.icq.com</emphasis> if it's an ICQ connection, or <emphasis>login.oscar.aol.com</emphasis> if it's an AIM connection. For Jabber, you have to set this if the servername isn't equal to the part after the @ in the Jabber handle.
+                                Can be set for Jabber- and OSCAR-connections. For Jabber, you might have to set this if the servername isn't equal to the part after the @ in the Jabber handle. For OSCAR this shouldn't be necessary anymore in recent BitlBee versions.
                         </para>
                 </description>
@@ -681 +681 @@
                         <para>
                                 Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
+                        </para>
+                </description>
+        </bitlbee-setting>
+
+        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
+                <default>false</default>
+
+                <description>
+                        <para>
+                                The Jabber module allows you to add a buddy <emphasis>xmlconsole</emphasis> to your contact list, which will then show you the raw XMPP stream between you and the server. You can also send XMPP packets to this buddy, which will then be sent to the server.
+                        </para>
+                        <para>
+                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
                         </para>
                 </description>
@@ -848 +861 @@
 
         </bitlbee-command>
+        
+        <bitlbee-command name="transfers">
+                <short-description>Monitor, cancel, or reject file transfers</short-description>
+                <syntax>transfers [&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.
+                        </para>
+
+                        <ircexample>
+                                <ircline nick="ulim">transfers</ircline>
+                        </ircexample>
+                </description>
+                
+                <bitlbee-command name="cancel">
+                        <short-description>Cancels the file transfer with the given id</short-description>
+                        <syntax>transfers &lt;cancel&gt; id</syntax>
+
+                        <description>
+                                <para>Cancels the file transfer with the given id</para>
+                        </description>
+
+                        <ircexample>
+                                <ircline nick="ulim">transfers cancel 1</ircline>
+                                <ircline nick="root">Canceling file transfer for test</ircline>
+                        </ircexample>
+                </bitlbee-command>
+
+                <bitlbee-command name="reject">
+                        <short-description>Rejects all incoming transfers</short-description>
+                        <syntax>transfers &lt;reject&gt;</syntax>
+
+                        <description>
+                                <para>Rejects all incoming (not already transferring) file transfers. Since you probably have only one incoming transfer at a time, no id is neccessary. Or is it?</para>
+                        </description>
+
+                        <ircexample>
+                                <ircline nick="ulim">transfers reject</ircline>
+                        </ircexample>
+                </bitlbee-command>
+        </bitlbee-command>
+        
 </chapter>