Changeset aa3b61e for doc

Timestamp:

2015-08-28T02:05:45Z (9 years ago)

Author:

dequis <dx@…>

Branches:

master

Children:

f5bbaba

Parents:

b6a3fbf

Message:

user-guide: add help for the jabber 'proxy' setting

File:

• doc/user-guide/commands.xml (modified) (1 diff)

doc/user-guide/commands.xml

@@ -1324 +1324 @@
         </bitlbee-setting>
 
+        <bitlbee-setting name="proxy" type="string" scope="account">
+                <default>&lt;local&gt;&lt;auto&gt;</default>
+
+                <description>
+                        <para>
+                                A list of <emphasis>file transfer proxies</emphasis> for jabber. This isn't the connection proxy. Sorry, look in bitlbee.conf for those.
+                        </para>
+
+                        <para>
+                                It's a semicolon-separated list of items that can be either <emphasis>JID,HOST,PORT</emphasis> or two special values, <emphasis>&lt;local&gt;</emphasis> (to try a direct connection first) and <emphasis>&lt;auto&gt;</emphasis> (to try to discover a proxy). For example, "&lt;local&gt;;proxy.somewhere.org,123.123.123.123,7777".
+                        </para>
+                        <para>
+                                The address should point to a SOCKS5 bytestreams server, usually provided by jabber servers. This is only used for sending files. Note that the host address might not match what DNS tells you, and the port isn't always the same.
+                        </para>
+                        <para>
+                                The correct way to get a socks proxy host/port is a mystery, and the file transfer might fail anyway. Maybe just try using dropbox instead.
+                        </para>
+                </description>
+        </bitlbee-setting>
+
         <bitlbee-setting name="query_order" type="string" scope="global">
                 <default>lifo</default>