Changeset 75554d0 for doc/user-guide/commands.xml

Timestamp:

2010-03-17T13:56:52Z (15 years ago)

Author:

Wilmer van der Gaast <wilmer@…>

Branches:

master

Children:

b788246

Parents:

e5e795d (diff), f9928cb (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:

Merging in 1.2.5.

File:

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

doc/user-guide/commands.xml

@@ -436 +436 @@
         </bitlbee-setting>
 
+        <bitlbee-setting name="away" type="string" scope="both">
+                <description>
+                        <para>
+                                To mark yourself as away, it is recommended to just use <emphasis>/away</emphasis>, like on normal IRC networks. If you want to mark yourself as away on only one IM network, you can use this per-account setting.
+                        </para>
+
+                        <para>
+                                You can set it to any value and BitlBee will try to map it to the most appropriate away state for every open IM connection, or set it as a free-form away message where possible.
+                        </para>
+
+                        <para>
+                                Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.
+                        </para>
+                </description>
+        </bitlbee-setting>
+
         <bitlbee-setting name="away_devoice" type="boolean" scope="global">
                 <default>true</default>
@@ -592 +608 @@
         </bitlbee-setting>
 
+        <bitlbee-setting name="nick_source" type="string" scope="account">
+                <default>handle</default>
+                <possible-values>handle, full_name, first_name</possible-values>
+
+                <description>
+                        <para>
+                                By default, BitlBee generates a nickname for every contact by taking its handle and chopping off everything after the @. In some cases, this gives very inconvenient nicknames. The Facebook XMPP server is a good example, as all Facebook XMPP handles are numeric.
+                        </para>
+
+                        <para>
+                                With this setting set to <emphasis>full_name</emphasis>, the person's full name is used to generate a nickname. Or if you don't like long nicknames, set this setting to <emphasis>first_name</emphasis> instead and only the first word will be used. Note that the full name can be full of non-ASCII characters which will be stripped off.
+                        </para>
+                </description>
+        </bitlbee-setting>
+
         <bitlbee-setting name="ops" type="string" scope="global">
                 <default>both</default>
@@ -685 +716 @@
 
         <bitlbee-setting name="resource_select" type="string" scope="account">
-                <default>priority</default>
+                <default>activity</default>
                 <possible-values>priority, activity</possible-values>
 
@@ -743 +774 @@
                         <para>
                                 Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
+                        </para>
+                </description>
+        </bitlbee-setting>
+
+        <bitlbee-setting name="status" type="string" scope="both">
+                <description>
+                        <para>
+                                Certain protocols (like Jabber/XMPP) support status messages, similar to away messages. They can be used to indicate things like your location or activity, without showing up as away/busy.
+                        </para>
+
+                        <para>
+                                This setting can be used to set such a message. It will be available as a per-account setting for protocols that support it, and also as a global setting (which will then automatically be used for all protocols that support it).
+                        </para>
+
+                        <para>
+                                Away states set using <emphasis>/away</emphasis> or the <emphasis>away</emphasis> setting will override this setting. To un-set the setting, use <emphasis>set -del status</emphasis>.
                         </para>
                 </description>