Changeset 0e99548

Timestamp:

2010-03-07T18:37:23Z (15 years ago)

Author:

Wilmer van der Gaast <wilmer@…>

Branches:

master

Children:

c32f492

Parents:

63770b4

Message:

Doc update.

Location:

doc/user-guide

Files:

• commands.xml (modified) (2 diffs)
• misc.xml (modified) (2 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>
@@ -747 +763 @@
         </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>

doc/user-guide/misc.xml

@@ -86 +86 @@
 
 <para>
-As you might've expected, you can just use the <emphasis>/away</emphasis> command in your IRC client to set an away-state. BitlBee supports most away-states supported by the protocols.
+To mark yourself as away, you can just use the <emphasis>/away</emphasis> command in your IRC client. BitlBee supports most away-states supported by the protocols.
 </para>
 
 <para>
-Not all away states are supported by all protocols, and some protocols have different names for them. BitlBee will try to pick the best available alias from this list for every connection:
+Away states have different names accross different protocols. BitlBee will try to pick the best available option for every connection:
 </para>
 
 <simplelist>
-        <member>Away from computer, Away, Extended away</member>
-        <member>NA, N/A, Not available</member>
-        <member>Busy, Do not disturb, DND, Occupied</member>
-        <member>Be right back, BRB</member>
-        <member>On the phone, Phone, On phone</member>
-        <member>Out to lunch, Lunch, Food</member>
+        <member>Away</member>
+        <member>NA</member>
+        <member>Busy, DND</member>
+        <member>BRB</member>
+        <member>Phone</member>
+        <member>Lunch, Food</member>
         <member>Invisible, Hidden</member>
 </simplelist>
 
 <para>
-So <emphasis>/away Food</emphasis> will set your state to "Out to lunch" on your MSN connection, and for most other connections the default, "Away" or "Away from computer" will be chosen.
+So <emphasis>/away Food</emphasis> will set your state to "Out to lunch" on your MSN connection, and for most other connections the default, "Away" will be chosen.
 </para>
 
@@ -111 +111 @@
 </para>
 
+<para>
+If you want to set an away state for only one of your connections, you can use the per-account <emphasis>away</emphasis> setting. See <emphasis>help set away</emphasis>.
+</para>
+
 </sect1>