aboutsummaryrefslogtreecommitdiffstats
path: root/doc/user-guide
diff options
context:
space:
mode:
Diffstat (limited to 'doc/user-guide')
-rw-r--r--doc/user-guide/commands.xml55
-rw-r--r--doc/user-guide/quickstart.xml4
2 files changed, 51 insertions, 8 deletions
diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml
index ac9bdf11..090acff3 100644
--- a/doc/user-guide/commands.xml
+++ b/doc/user-guide/commands.xml
@@ -16,7 +16,7 @@
</description>
<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>
<para>
@@ -25,7 +25,7 @@
</description>
<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>
<para>
@@ -49,16 +49,16 @@
</bitlbee-command>
<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>
</bitlbee-command>
@@ -594,7 +594,7 @@
<bitlbee-setting name="server" type="string" scope="account">
<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>
</bitlbee-setting>
@@ -860,4 +860,47 @@
</ircexample>
</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>
diff --git a/doc/user-guide/quickstart.xml b/doc/user-guide/quickstart.xml
index 520f240f..fcb06c6b 100644
--- a/doc/user-guide/quickstart.xml
+++ b/doc/user-guide/quickstart.xml
@@ -37,12 +37,12 @@ For instance, suppose you have an ICQ account with UIN <emphasis>72696705</empha
</para>
<ircexample>
- <ircline nick="you">account add oscar 72696705 QuickStart login.icq.com</ircline>
+ <ircline nick="you">account add jabber bitlbee@jabber.org QuickStart</ircline>
<ircline nick="root">Account successfully added</ircline>
</ircexample>
<para>
-Other available IM protocols are jabber, msn, and yahoo. Oscar is the protocol used by ICQ and AOL. For oscar, you need to specify the IM-server as a fourth argument (for msn and yahoo there is no fourth argument). For AOL Instant Messenger, the server name is <emphasis>login.oscar.aol.com</emphasis>. For ICQ, the server name is <emphasis>login.icq.com</emphasis>.
+Other available IM protocols are msn, oscar, and yahoo. Oscar is the protocol used by ICQ and AOL.
</para>
<para>