Changeset 0e99548 for doc/user-guide


Ignore:
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:
2 edited

Legend:

Unmodified
Added
Removed

  • doc/user-guide/commands.xml

    r63770b4 r0e99548  
    436436        </bitlbee-setting>
    437437
     438        <bitlbee-setting name="away" type="string" scope="both">
     439                <description>
     440                        <para>
     441                                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.
     442                        </para>
     443
     444                        <para>
     445                                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.
     446                        </para>
     447
     448                        <para>
     449                                Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.
     450                        </para>
     451                </description>
     452        </bitlbee-setting>
     453
    438454        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
    439455                <default>true</default>
    … …  
    747763        </bitlbee-setting>
    748764
     765        <bitlbee-setting name="status" type="string" scope="both">
     766                <description>
     767                        <para>
     768                                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.
     769                        </para>
     770
     771                        <para>
     772                                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).
     773                        </para>
     774
     775                        <para>
     776                                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>.
     777                        </para>
     778                </description>
     779        </bitlbee-setting>
     780
    749781        <bitlbee-setting name="strip_html" type="boolean" scope="global">
    750782                <default>true</default>

  • doc/user-guide/misc.xml

    r63770b4 r0e99548  
    8686
    8787<para>
    88 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.
     88To 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.
    8989</para>
    9090
    9191<para>
    92 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:
     92Away states have different names accross different protocols. BitlBee will try to pick the best available option for every connection:
    9393</para>
    9494
    9595<simplelist>
    96         <member>Away from computer, Away, Extended away</member>
    97         <member>NA, N/A, Not available</member>
    98         <member>Busy, Do not disturb, DND, Occupied</member>
    99         <member>Be right back, BRB</member>
    100         <member>On the phone, Phone, On phone</member>
    101         <member>Out to lunch, Lunch, Food</member>
     96        <member>Away</member>
     97        <member>NA</member>
     98        <member>Busy, DND</member>
     99        <member>BRB</member>
     100        <member>Phone</member>
     101        <member>Lunch, Food</member>
    102102        <member>Invisible, Hidden</member>
    103103</simplelist>
    104104
    105105<para>
    106 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.
     106So <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.
    107107</para>
    108108
    … …  
    111111</para>
    112112
     113<para>
     114If 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>.
     115</para>
     116
    113117</sect1>
    114118
Note: See TracChangeset for help on using the changeset viewer.