Changeset ee5c355


Ignore:
Timestamp:
2006-10-15T15:01:13Z (14 years ago)
Author:
Wilmer van der Gaast <wilmer@…>
Branches:
master
Children:
e617b35
Parents:
93b7bd4
Message:

Documentation updates.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user-guide/commands.xml

    r93b7bd4 ree5c355  
    3030                                <description>
    3131                                        <para>
    32                                                 Note that the servertag argument is optional. You only have to use it if the part after the @ in your handle isn't the hostname of your Jabber server, or if you want to use SSL/connect to a non-standard port number. The format is simple: [&lt;servername&gt;[:&lt;portnumber&gt;][:ssl]].
     32                                                The handle should be a full handle, including the domain name. You can specify a servername if necessary. Normally BitlBee doesn't need this though, since it's able to find out the server by doing DNS SRV lookups.
     33                                        </para>
     34
     35                                        <para>
     36                                                In previous versions it was also possible to specify port numbers and/or SSL in the server tag. This is deprecated and should now be done using the <emphasis>account set</emphasis> command. This also applies to specifying a resource in the handle (like <emphasis>wilmer@bitlbee.org/work</emphasis>).
    3337                                        </para>
    3438                                </description>
    35 
    36                                 <description>
    37                                         <para>
    38                                                 Google Talk uses the Jabber protocol. Please note that Google talk is SSL-only, but officially reachable over both port 5222 and 5223. Usually BitlBee users have to connect via port 5223, for example like this:
    39                                         </para>
    40                                 </description>
    41 
    42                                 <ircexample>
    43                                         <ircline nick="wilmer">account add jabber example@gmail.com hobbelmeeuw talk.google.com:5223:ssl</ircline>
    44                                         <ircline nick="root">Account successfully added</ircline>
    45                                 </ircexample>
    4639                        </bitlbee-command>
    4740
     
    515508        </bitlbee-setting>
    516509
     510        <bitlbee-setting name="priority" type="integer" scope="account">
     511                <default>0</default>
     512
     513                <description>
     514                        <para>
     515                                Can be set for Jabber connections. When connecting to one account from multiple places, this priority value will help the server to determine where to deliver incoming messages (that aren't addressed to a specific resource already).
     516                        </para>
     517
     518                        <para>
     519                                According to RFC 3921 servers will always deliver messages to the server with the highest priority value. Mmessages will not be delivered to resources with a negative priority setting (and should be saved as an off-line message if all available resources have a negative priority value).
     520                        </para>
     521                </description>
     522        </bitlbee-setting>
     523
    517524        <bitlbee-setting name="private" type="boolean" scope="global">
    518525                <default>true</default>
     
    554561        </bitlbee-setting>
    555562
     563        <bitlbee-setting name="resource_select" type="string" scope="account">
     564                <default>priority</default>
     565                <possible-values>priority, time</possible-values>
     566
     567                <description>
     568                        <para>
     569                                Because the IRC interface makes it pretty hard to specify the resource to talk to (when a buddy is online through different resources), this setting was added.
     570                        </para>
     571
     572                        <para>
     573                                Normally it's set to <emphasis>priority</emphasis> which means messages will always be delivered to the buddy's resource with the highest priority. If the setting is set to <emphasis>time</emphasis>, messages will be delivered to the resource that was last used to send you a message (or the resource that most recently connected).
     574                        </para>
     575                </description>
     576        </bitlbee-setting>
     577
    556578        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
    557579                <default>true</default>
     
    591613                        <para>
    592614                                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.
     615                        </para>
     616                </description>
     617        </bitlbee-setting>
     618
     619        <bitlbee-setting name="tls" type="boolean" scope="account">
     620                <default>try</default>
     621
     622                <description>
     623                        <para>
     624                                Newer Jabber servers allow clients to convert a plain-text session to a TLS/SSL-encrypted session. Normally (with this setting set to <emphasis>try</emphasis>) BitlBee will do this, if possible.
     625                        </para>
     626
     627                        <para>
     628                                If you want to force BitlBee to use TLS sessions only (and to give up if that doesn't seem to be possible) you can set this setting to <emphasis>true</emphasis>. Set it to <emphasis>false</emphasis> if you want the session to remain plain-text.
    593629                        </para>
    594630                </description>
Note: See TracChangeset for help on using the changeset viewer.