Changeset 29ff5c2 for doc/user-guide/commands.xml

Timestamp:

2015-11-21T00:01:50Z (8 years ago)

Author:

dequis <dx@…>

Parents:

e4f08bf (diff), 8fdeaa5 (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 branch 'master' into feat/hip-cat

File:

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

doc/user-guide/commands.xml

@@ -182 +182 @@
                                 
                                 <para>
-                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
+                                        For more information about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
                                 </para>
                                 
@@ -240 +240 @@
                                 
                                 <para>
-                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
+                                        For more information about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>.
                                 </para>
                                 
@@ -1093 +1093 @@
                         
                         <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.
+                                With modes "chat" and "many", you can send direct messages by /msg'ing your contacts directly. Incoming DMs are only fetched if the "stream" setting is on (default).
                         </para>
                         
@@ -1186 +1186 @@
         </bitlbee-setting>
 
+        <bitlbee-setting name="anonymous" type="boolean" scope="account">
+                <default>false</default>
+
+                <description>
+                        <para>
+                                This enables SASL ANONYMOUS login for jabber accounts, as specified by XEP-0175.
+                        </para>
+
+                        <para>
+                                With this setting enabled, if the server allows this method, a password isn't required and the username part of the JID is ignored (you can use anonymous@jabber.example.com). Servers will usually assign you a random numeric username instead.
+                        </para>
+                </description>
+
+        </bitlbee-setting>
+
         <bitlbee-setting name="ops" type="string" scope="global">
                 <default>both</default>
@@ -1309 +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>
@@ -1369 +1404 @@
         </bitlbee-setting>
 
+        <bitlbee-setting name="self_messages" type="string" scope="global">
+                <default>true</default>
+                <possible-values>true, false, prefix, prefix_notice</possible-values>
+
+                <description>
+                        <para>
+                                Change this setting to customize how (or whether) to show self-messages, which are messages sent by yourself from other locations (for example, mobile clients), for IM protocols that support it.
+                        </para>
+
+                        <para>
+                                When this is set to "true", it will send those messages in the "standard" way, which is a PRIVMSG with source and target fields swapped.
+                        </para>
+                        
+                        <para>
+                                Since this isn't very well supported by some clients (the messages might appear in the wrong window), you can set it to "prefix" to show them as a normal message prefixed with "-> ", or use "prefix_notice" which is the same thing but with a NOTICE instead.
+                        </para>
+
+                        <para>
+                                You can also set it to "false" to disable these messages completely.
+                        </para>
+
+                        <para>
+                                This setting only applies to private messages. Self messages in groupchats are always shown, since they haven't caused issues in any clients so far.
+                        </para>
+                </description>
+        </bitlbee-setting>
+
         <bitlbee-setting name="server" type="string" scope="account">
                 <description>
@@ -1402 +1464 @@
 
         <bitlbee-setting name="show_users" type="string" scope="channel">
-                <default>online+,away</default>
+                <default>online+,special%,away</default>
 
                 <description>
@@ -1409 +1471 @@
                                 and any modes they should have. The following statuses are currently
                                 recognised: <emphasis>online</emphasis> (i.e. available, not
-                                away), <emphasis>away</emphasis>, and <emphasis>offline</emphasis>.
+                                away), <emphasis>special</emphasis>, <emphasis>away</emphasis>,
+                                and <emphasis>offline</emphasis>.
                         </para>
                         
@@ -1415 +1478 @@
                                 If a status is followed by a valid channel mode character
                                 (@, % or +), it will be given to users with that status.
-                                For example, <emphasis>online@,away+,offline</emphasis> will
-                                show all users in the channel. Online people will
+                                For example, <emphasis>online@,special%,away+,offline</emphasis>
+                                will show all users in the channel. Online people will
                                 have +o, people who are online but away will have +v,
                                 and others will have no special modes.
@@ -1876 +1939 @@
 
                         <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>
+                                <para>Rejects all incoming (not already transferring) file transfers. Since you probably have only one incoming transfer at a time, no id is necessary. Or is it?</para>
                         </description>