Changeset 5f8ab6a9 for doc/user-guide


Ignore:
Timestamp:
2010-06-03T10:41:03Z (15 years ago)
Author:
Sven Moritz Hallberg <pesco@…>
Branches:
master
Children:
814aa52
Parents:
3f81999 (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:

merge in bitlbee 1.2.5

Location:
doc/user-guide
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • doc/user-guide/commands.xml

    r3f81999 r5f8ab6a9  
    585585        </bitlbee-setting>
    586586
     587        <bitlbee-setting name="away" type="string" scope="both">
     588                <description>
     589                        <para>
     590                                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.
     591                        </para>
     592
     593                        <para>
     594                                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.
     595                        </para>
     596
     597                        <para>
     598                                Any per-account away setting will override globally set away states. To un-set the setting, use <emphasis>set -del away</emphasis>.
     599                        </para>
     600                </description>
     601        </bitlbee-setting>
     602
    587603        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
    588604                <default>true</default>
    … …  
    818834        </bitlbee-setting>
    819835
     836        <bitlbee-setting name="nick_source" type="string" scope="account">
     837                <default>handle</default>
     838                <possible-values>handle, full_name, first_name</possible-values>
     839
     840                <description>
     841                        <para>
     842                                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.
     843                        </para>
     844
     845                        <para>
     846                                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.
     847                        </para>
     848                </description>
     849        </bitlbee-setting>
     850
     851        <bitlbee-setting name="ops" type="string" scope="global">
     852                <default>both</default>
     853                <possible-values>both, root, user, none</possible-values>
     854
     855                <description>
     856                        <para>
     857                                Some people prefer themself and root to have operator status in &amp;bitlbee, other people don't. You can change these states using this setting.
     858                        </para>
     859
     860                        <para>
     861                                The value "both" means both user and root get ops. "root" means, well, just root. "user" means just the user. "none" means nobody will get operator status.
     862                        </para>
     863                </description>
     864        </bitlbee-setting>
     865
    820866        <bitlbee-setting name="password" type="string" scope="both">
    821867                <description>
    … …  
    896942
    897943        <bitlbee-setting name="resource_select" type="string" scope="account">
    898                 <default>priority</default>
     944                <default>activity</default>
    899945                <possible-values>priority, activity</possible-values>
    900946
    … …  
    9541000                        <para>
    9551001                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
     1002                        </para>
     1003                </description>
     1004        </bitlbee-setting>
     1005
     1006        <bitlbee-setting name="status" type="string" scope="both">
     1007                <description>
     1008                        <para>
     1009                                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.
     1010                        </para>
     1011
     1012                        <para>
     1013                                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).
     1014                        </para>
     1015
     1016                        <para>
     1017                                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>.
    9561018                        </para>
    9571019                </description>

  • doc/user-guide/misc.xml

    r3f81999 r5f8ab6a9  
    7777
    7878<para>
    79 Some protocols (like Jabber) also support named groupchats. BitlBee now supports these too. You can use the <emphasis>chat add</emphasis> command to join them. See <emphasis>help chat_add</emphasis> for more information.
     79Some protocols (like Jabber) also support named groupchats. BitlBee now supports these too. You can use the <emphasis>chat add</emphasis> command to join them. See <emphasis>help chat add</emphasis> for more information.
    8080</para>
    8181
    … …  
    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.