Changes in doc/user-guide/commands.xml [57d8421:3e57660]

File:

• doc/user-guide/commands.xml (modified) (8 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>
@@ -493 +509 @@
                 </description>
 
+        </bitlbee-setting>
+
+        <bitlbee-setting name="control_channel" type="string" scope="global">
+                <default>&amp;bitlbee</default>
+
+                <description>
+                        <para>
+                                Normally the control channel where you can see all your contacts is called "&amp;bitlbee". If you don't like this name, you can rename it to anything else using the <emphasis>rename</emphasis> command, or by changing this setting.
+                        </para>
+                </description>
         </bitlbee-setting>
 
@@ -561 +587 @@
         </bitlbee-setting>
 
+        <bitlbee-setting name="ignore_auth_requests" type="boolean" scope="account">
+                <default>true</default>
+
+                <description>
+                        <para>
+                                Only supported by OSCAR so far, you can use this setting to ignore ICQ authorization requests, which are hardly used for legitimate (i.e. non-spam) reasons anymore.
+                        </para>
+                </description>
+
+        </bitlbee-setting>
+
         <bitlbee-setting name="lcnicks" type="boolean" scope="global">
                 <default>true</default>
@@ -572 +609 @@
         </bitlbee-setting>
 
+        <bitlbee-setting name="local_display_name" type="boolean" scope="account">
+                <default>false</default>
+
+                <description>
+                        <para>
+                                Mostly meant to work around a bug in MSN servers (forgetting the display name set by the user), this setting tells BitlBee to store your display name locally and set this name on the MSN servers when connecting.
+                        </para>
+                </description>
+
+        </bitlbee-setting>
+
         <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
                 <default>false</default>
@@ -588 +636 @@
                         <para>
                                 You can use this option to set your nickname in a chatroom. You won't see this nickname yourself, but other people in the room will. By default, BitlBee will use your username as the chatroom nickname.
+                        </para>
+                </description>
+        </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>
@@ -685 +748 @@
 
         <bitlbee-setting name="resource_select" type="string" scope="account">
-                <default>priority</default>
+                <default>activity</default>
                 <possible-values>priority, activity</possible-values>
 
@@ -747 +810 @@
         </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>
+        </bitlbee-setting>
+
         <bitlbee-setting name="strip_html" type="boolean" scope="global">
                 <default>true</default>
@@ -756 +835 @@
                         <para>
                                 If BitlBee fails to detect this sometimes (most likely in AIM messages over an ICQ connection), you can set this setting to <emphasis>always</emphasis>, but this might sometimes accidentally strip non-HTML things too.
+                        </para>
+                </description>
+        </bitlbee-setting>
+
+        <bitlbee-setting name="timezone" type="string" scope="global">
+                <default>local</default>
+                <possible-values>local, utc, gmt, timezone-spec</possible-values>
+
+                <description>
+                        <para>
+                                If message timestamps are available for offline messages or chatroom backlogs, BitlBee will display them as part of the message. By default it will use the local timezone. If you're not in the same timezone as the BitlBee server, you can adjust the timestamps using this setting.
+                        </para>
+
+                        <para>
+                                Values local/utc/gmt should be self-explanatory. timezone-spec is a time offset in hours:minutes, for example: -8 for Pacific Standard Time, +2 for Central European Summer Time, +5:30 for Indian Standard Time.
                         </para>
                 </description>