Ignore:
Timestamp:
2008-04-02T14:22:57Z (16 years ago)
Author:
Jelmer Vernooij <jelmer@…>
Branches:
master
Children:
f9dbc99
Parents:
875ad42 (diff), dd34575 (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 trunk.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • doc/user-guide/commands.xml

    r875ad42 r85d7b85  
    1111
    1212                        <para>
    13                                 Available actions: add, del, list, on, off. See <emphasis>help account &lt;action&gt;</emphasis> for more information.
     13                                Available actions: add, del, list, on, off and set. See <emphasis>help account &lt;action&gt;</emphasis> for more information.
    1414                        </para>
    1515
    … …  
    1717
    1818                <bitlbee-command name="add">
    19                         <syntax>account add &lt;protocol&gt; &lt;username&gt; &lt;password&gt; [&lt;server&gt;]</syntax>
     19                        <syntax>account add &lt;protocol&gt; &lt;username&gt; &lt;password&gt;</syntax>
    2020
    2121                        <description>
    … …  
    2626                       
    2727                        <bitlbee-command name="jabber">
    28                                 <syntax>account add jabber &lt;handle&gt; &lt;password&gt; [&lt;servertag&gt;]</syntax>
     28                                <syntax>account add jabber &lt;handle@server.tld&gt; &lt;password&gt;</syntax>
    2929
    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]]. For example, this is how you can connect to Google Talk:
     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.
    3333                                        </para>
    34                                 </description>
    35 
    36                                 <ircexample>
    37                                         <ircline nick="wilmer">account add jabber example@gmail.com hobbelmeeuw talk.google.com:5223:ssl</ircline>
    38                                         <ircline nick="root">Account successfully added</ircline>
    39                                 </ircexample>
    40 
    41                                 <description>
     34
    4235                                        <para>
    43                                                 Note that Google talk is SSL-only, but officially reachable over both port 5222 and 5223. However, for some people only port 5222 works, for some people only 5223. This is something you'll have to try out.
     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>).
    4437                                        </para>
    4538                                </description>
    … …  
    4740
    4841                        <bitlbee-command name="msn">
    49                                 <syntax>account add msn &lt;handle&gt; &lt;password&gt;</syntax>
     42                                <syntax>account add msn &lt;handle@server.tld&gt; &lt;password&gt;</syntax>
    5043
    5144                                <description>
    … …  
    5750                       
    5851                        <bitlbee-command name="oscar">
    59                                 <syntax>account add oscar &lt;handle&gt; &lt;password&gt; [&lt;servername&gt;]</syntax>
     52                                <syntax>account add oscar &lt;handle&gt; &lt;password&gt;</syntax>
    6053
    6154                                <description>
    6255                                        <para>
    63                                                 Specifying a server is required for OSCAR, since OSCAR can be used for both ICQ- and AIM-connections. Although these days it's supposed to be possible to connect to ICQ via AIM-servers and vice versa, we like to stick with this separation for now. For ICQ connections, the servername is <emphasis>login.icq.com</emphasis>, for AIM connections it's <emphasis>login.oscar.aol.com</emphasis>.
     56                                                OSCAR is the protocol used to connect to AIM and/or ICQ. The servers will automatically detect if you're using a numeric or non-numeric username so there's no need to tell which network you want to connect to.
    6457                                        </para>
    6558                                </description>
    6659
    6760                                <ircexample>
    68                                         <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw login.icq.com</ircline>
     61                                        <ircline nick="wilmer">account add oscar 72696705 hobbelmeeuw</ircline>
    6962                                        <ircline nick="root">Account successfully added</ircline>
    7063                                </ircexample>
    … …  
    10396                        <description>
    10497                                <para>
    105                                         This command will try to log into the specified account. If no account is specified, BitlBee will log into all the accounts. (Including accounts awaiting a reconnection)
     98                                        This command will try to log into the specified account. If no account is specified, BitlBee will log into all the accounts that have the auto_connect flag set.
    10699                                </para>
    107100
    … …  
    118111                        <description>
    119112                                <para>
    120                                         This command disconnects the connection for the specified account. If no account is specified, BitlBee will deactivate all active accounts. (Including accounts awaiting a reconnection)
     113                                        This command disconnects the connection for the specified account. If no account is specified, BitlBee will deactivate all active accounts and cancel all pending reconnects.
    121114                                </para>
    122115
    … …  
    133126                                <para>
    134127                                        This command gives you a list of all the accounts known by BitlBee, including the numbers you'll need for most account commands.
     128                                </para>
     129                        </description>
     130                </bitlbee-command>
     131
     132                <bitlbee-command name="set">
     133                        <syntax>account set &lt;account id&gt;</syntax>
     134                        <syntax>account set &lt;account id&gt;/&lt;setting&gt;</syntax>
     135                        <syntax>account set &lt;account id&gt;/&lt;setting&gt; &lt;value&gt;</syntax>
     136                        <syntax>account set -del &lt;account id&gt;/&lt;setting&gt;</syntax>
     137
     138                        <description>
     139                                <para>
     140                                        This account can be used to change various settings for IM accounts. For all protocols, this command can be used to change the handle or the password BitlBee uses to log in and if it should be logged in automatically. Some protocols have additional settings. You can see the settings available for a connection by typing <emphasis>account set &lt;account id&gt;</emphasis>.
     141                                </para>
     142                               
     143                                <para>
     144                                        For more infomation about a setting, see <emphasis>help set &lt;setting&gt;</emphasis>. For details about the syntax of this command, see <emphasis>help set</emphasis>.
     145                                </para>
     146                               
     147                                <para>
     148                                        The account ID can be a number (see <emphasis>account list</emphasis>), the protocol name or (part of) the screenname, as long as it matches only one connection.
    135149                                </para>
    136150                        </description>
    … …  
    149163
    150164                        <para>
    151                                 If you want, you can also tell BitlBee what nick to give the new contact. Of course you can also use the <emphasis>rename</emphasis> command for that, but sometimes this might be more convenient.
    152                         </para>
    153                        
    154                         <para>
    155                                 Adding -tmp adds the buddy to the internal BitlBee structures only, not to the real contact list (like done by <emphasis>set handle_unknown add</emphasis>). This allows you to talk to people who are not in your contact list.
     165                                If you want, you can also tell BitlBee what nick to give the new contact. The -tmp option adds the buddy to the internal BitlBee structures only, not to the real contact list (like done by <emphasis>set handle_unknown add</emphasis>). This allows you to talk to people who are not in your contact list. This normally won't show you any presence notifications.
    156166                        </para>
    157167                </description>
    … …  
    233243        <bitlbee-command name="set">
    234244                <short-description>Miscellaneous settings</short-description>
    235                 <syntax>set [&lt;variable&gt; [&lt;value&gt;]]</syntax>
    236 
    237                 <description>
    238 
    239                         <para>
    240                                 Without any arguments, this command lists all the set variables. You can also specify a single argument, a variable name, to get that variable's value. To change this value, specify the new value as the second argument.
     245                <syntax>set</syntax>
     246                <syntax>set &lt;variable&gt;</syntax>
     247                <syntax>set &lt;variable&gt; &lt;value&gt;</syntax>
     248                <syntax>set -del &lt;variable&gt;</syntax>
     249
     250                <description>
     251
     252                        <para>
     253                                Without any arguments, this command lists all the set variables. You can also specify a single argument, a variable name, to get that variable's value. To change this value, specify the new value as the second argument. With <emphasis>-del</emphasis> you can reset a setting to its default value.
    241254                        </para>
    242255
    … …  
    276289        </bitlbee-command>
    277290
    278         <bitlbee-setting name="charset" type="string">
    279                 <default>iso8859-1</default>
     291        <bitlbee-setting name="auto_connect" type="boolean" scope="both">
     292                <default>true</default>
     293
     294                <description>
     295                        <para>
     296                                With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
     297                        </para>
     298                       
     299                        <para>
     300                                This setting can also be changed for specific accounts using the <emphasis>account set</emphasis> command. (However, these values will be ignored if the global <emphasis>auto_connect</emphasis> setting is disabled!)
     301                        </para>
     302                </description>
     303        </bitlbee-setting>
     304
     305        <bitlbee-setting name="auto_reconnect" type="boolean" scope="both">
     306                <default>false</default>
     307
     308                <description>
     309                        <para>
     310                                If an IM-connections breaks, you're supposed to bring it back up yourself. Having BitlBee do this automatically might not always be a good idea, for several reasons. If you want the connections to be restored automatically, you can enable this setting.
     311                        </para>
     312
     313                        <para>
     314                                See also the <emphasis>auto_reconnect_delay</emphasis> setting.
     315                        </para>
     316
     317                        <para>
     318                                This setting can also be changed for specific accounts using the <emphasis>account set</emphasis> command. (However, these values will be ignored if the global <emphasis>auto_reconnect</emphasis> setting is disabled!)
     319                        </para>
     320                </description>
     321        </bitlbee-setting>
     322
     323        <bitlbee-setting name="auto_reconnect_delay" type="integer" scope="global">
     324                <default>300</default>
     325
     326                <description>
     327                        <para>
     328                                Tell BitlBee after how many seconds it should attempt to bring an IM-connection back up after a crash. It's not a good idea to set this value very low, it will cause too much useless traffic when an IM-server is down for a few hours.
     329                        </para>
     330
     331                        <para>
     332                                See also the <emphasis>auto_reconnect</emphasis> setting.
     333                        </para>
     334                </description>
     335        </bitlbee-setting>
     336
     337        <bitlbee-setting name="away_devoice" type="boolean" scope="global">
     338                <default>true</default>
     339
     340                <description>
     341                        <para>
     342                                With this option enabled, the root user devoices people when they go away (just away, not offline) and gives the voice back when they come back. You might dislike the voice-floods you'll get if your contact list is huge, so this option can be disabled.
     343                        </para>
     344                </description>
     345        </bitlbee-setting>
     346
     347        <bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global">
     348                <default>false</default>
     349
     350                <description>
     351                        <para>
     352                                By default, when you send a message to someone, BitlBee forwards this message to the user immediately. When you paste a large number of lines, the lines will be sent in separate messages, which might not be very nice to read. If you enable this setting, BitlBee will buffer your messages and wait for more data.
     353                        </para>
     354
     355                        <para>
     356                                Using the <emphasis>buddy_sendbuffer_delay</emphasis> setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent.
     357                        </para>
     358
     359                        <para>
     360                                Please note that if you remove a buddy from your list (or if the connection to that user drops) and there's still data in the buffer, this data will be lost. BitlBee will not try to send the message to the user in those cases.
     361                        </para>
     362                </description>
     363        </bitlbee-setting>
     364
     365        <bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global">
     366                <default>200</default>
     367
     368                <description>
     369
     370                        <para>
     371                                Tell BitlBee after how many (mili)seconds a buffered message should be sent. Values greater than 5 will be interpreted as miliseconds, 5 and lower as seconds.
     372                        </para>
     373
     374                        <para>
     375                                See also the <emphasis>buddy_sendbuffer</emphasis> setting.
     376                        </para>
     377                </description>
     378        </bitlbee-setting>
     379
     380        <bitlbee-setting name="charset" type="string" scope="global">
     381                <default>utf-8</default>
    280382                <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values>
    281383
    282384                <description>
    283385                        <para>
    284                                 The charset setting enables you to use different character sets in BitlBee. These get converted to UTF-8 before sending and from UTF-8 when receiving.
    285                         </para>
    286 
    287                         <para>
    288                                 If you don't know what's the best value for this, at least iso8859-1 is the best choice for most Western countries. You can try to find what works best for you on http://czyborra.com/charsets/iso8859.html
    289                         </para>
    290                 </description>
    291 
    292         </bitlbee-setting>
    293 
    294         <bitlbee-setting name="private" type="boolean">
    295                 <default>True</default>
    296 
    297                 <description>
    298 
    299                         <para>
    300                                 If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
    301                         </para>
    302 
    303                         <para>
    304                                 This setting is remembered (during one session) per-user, this setting only changes the default state. This option takes effect as soon as you reconnect.
    305                         </para>
    306                 </description>
    307         </bitlbee-setting>
    308 
    309         <bitlbee-setting name="save_on_quit" type="boolean">
    310                 <default>True</default>
    311 
    312                 <description>
    313                         <para>
    314                                 If enabled causes BitlBee to save all current settings and account details when user disconnects. This is enabled by default, and these days there's not really a reason to have it disabled anymore.
    315                         </para>
    316                 </description>
    317         </bitlbee-setting>
    318 
    319         <bitlbee-setting name="strip_html" type="boolean">
    320                 <default>True</default>
    321 
    322                 <description>
    323                         <para>
    324                                 Determines what BitlBee should do with HTML in messages. Normally this is turned on and HTML will be stripped from messages, if BitlBee thinks there is HTML.
    325                         </para>
    326                         <para>
    327                                 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.
    328                         </para>
    329                 </description>
    330         </bitlbee-setting>
    331 
    332         <bitlbee-setting name="debug" type="boolean">
    333                 <default>False</default>
     386                                This setting tells BitlBee what your IRC client sends and expects. It should be equal to the charset setting of your IRC client if you want to be able to send and receive non-ASCII text properly.
     387                        </para>
     388
     389                        <para>
     390                                Most systems use UTF-8 these days. On older systems, an iso8859 charset may work better. For example, iso8859-1 is the best choice for most Western countries. You can try to find what works best for you on http://www.unicodecharacter.com/charsets/iso8859.html
     391                        </para>
     392                </description>
     393
     394        </bitlbee-setting>
     395
     396        <bitlbee-setting name="debug" type="boolean" scope="global">
     397                <default>false</default>
    334398
    335399                <description>
    … …  
    340404        </bitlbee-setting>
    341405
    342         <bitlbee-setting name="to_char" type="string">
    343                 <default>": "</default>
    344 
    345                 <description>
    346 
    347                         <para>
    348                                 It's customary that messages meant for one specific person on an IRC channel are prepended by his/her alias followed by a colon ':'. BitlBee does this by default. If you prefer a different character, you can set it using <emphasis>set to_char</emphasis>.
    349                         </para>
    350 
    351                         <para>
    352                                 Please note that this setting is only used for incoming messages. For outgoing messages you can use ':' (colon) or ',' to separate the destination nick from the message, and this is not configurable.
    353                         </para>
    354                 </description>
    355         </bitlbee-setting>
    356 
    357         <bitlbee-setting name="typing_notice" type="boolean">
    358                 <default>False</default>
    359 
    360                 <description>
    361                         <para>
    362                                 Sends you a /notice when a user starts typing a message (if the protocol supports it, MSN for example). This is a bug, not a feature. (But please don't report it.. ;-) You don't want to use it. Really. In fact the typing-notification is just one of the least useful 'innovations' ever. It's just there because some guy will probably ask me about it anyway. ;-)
    363                         </para>
    364                 </description>
    365         </bitlbee-setting>
    366 
    367         <bitlbee-setting name="ops" type="string">
    368                 <default>both</default>
    369                 <possible-values>both, root, user, none</possible-values>
    370 
    371                 <description>
    372                         <para>
    373                                 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.
    374                         </para>
    375 
    376                         <para>
    377                                 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.
    378                         </para>
    379                 </description>
    380         </bitlbee-setting>
    381 
    382         <bitlbee-setting name="away_devoice" type="boolean">
    383                 <default>True</default>
    384 
    385                 <description>
    386                         <para>
    387                                 With this option enabled, the root user devoices people when they go away (just away, not offline) and gives the voice back when they come back. You might dislike the voice-floods you'll get if your contact list is huge, so this option can be disabled.
    388                         </para>
    389                 </description>
    390         </bitlbee-setting>
    391 
    392         <bitlbee-setting name="handle_unknown" type="string">
     406        <bitlbee-setting name="default_target" type="string" scope="global">
     407                <default>root</default>
     408                <possible-values>root, last</possible-values>
     409
     410                <description>
     411                        <para>
     412                                With this value set to <emphasis>root</emphasis>, lines written in the control channel without any nickname in front of them will be interpreted as commands. If you want BitlBee to send those lines to the last person you addressed in the control channel, set this to <emphasis>last</emphasis>.
     413                        </para>
     414                </description>
     415        </bitlbee-setting>
     416
     417        <bitlbee-setting name="display_name" type="string" scope="account">
     418                <description>
     419                        <para>
     420                                Currently only available for MSN connections. This setting allows you to read and change your "friendly name" for this connection. Since this is a server-side setting, it can't be changed when the account is off-line.
     421                        </para>
     422                </description>
     423        </bitlbee-setting>
     424
     425        <bitlbee-setting name="display_namechanges" type="boolean" scope="global">
     426                <default>false</default>
     427
     428                <description>
     429                        <para>
     430                                With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
     431                        </para>
     432                </description>
     433        </bitlbee-setting>
     434
     435        <bitlbee-setting name="handle_unknown" type="string" scope="global">
    393436                <default>root</default>
    394437                <possible-values>root, add, add_private, add_channel, ignore</possible-values>
    … …  
    417460        </bitlbee-setting>
    418461
    419         <bitlbee-setting name="auto_connect" type="boolean">
    420                 <default>True</default>
    421 
    422                 <description>
    423                         <para>
    424                                 With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this.
    425                         </para>
    426                 </description>
    427         </bitlbee-setting>
    428 
    429         <bitlbee-setting name="auto_reconnect" type="boolean">
    430                 <default>False</default>
    431 
    432                 <description>
    433                         <para>
    434                                 If an IM-connections breaks, you're supposed to bring it back up yourself. Having BitlBee do this automatically might not always be a good idea, for several reasons. If you want the connections to be restored automatically, you can enable this setting.
    435                         </para>
    436 
    437                         <para>
    438                                 See also the <emphasis>auto_reconnect_delay</emphasis> setting.
    439                         </para>
    440                 </description>
    441 
    442         </bitlbee-setting>
    443 
    444         <bitlbee-setting name="auto_reconnect_delay" type="integer">
    445                 <default>300</default>
    446 
    447                 <description>
    448 
    449                         <para>
    450                                 Tell BitlBee after how many seconds it should attempt to bring an IM-connection back up after a crash. It's not a good idea to set this value very low, it will cause too much useless traffic when an IM-server is down for a few hours.
    451                         </para>
    452 
    453                         <para>
    454                                 See also the <emphasis>auto_reconnect</emphasis> setting.
    455                         </para>
    456                 </description>
    457         </bitlbee-setting>
    458 
    459         <bitlbee-setting name="buddy_sendbuffer" type="boolean">
    460                 <default>False</default>
    461 
    462                 <description>
    463 
    464                         <para>
    465                                 By default, when you send a message to someone, BitlBee forwards this message to the user immediately. When you paste a large number of lines, the lines will be sent in separate messages, which might not be very nice to read. If you enable this setting, BitlBee will buffer your messages and wait for more data.
    466                         </para>
    467 
    468                         <para>
    469                                 Using the <emphasis>buddy_sendbuffer_delay</emphasis> setting you can specify the number of seconds BitlBee should wait for more data before the complete message is sent.
    470                         </para>
    471 
    472                         <para>
    473                                 Please note that if you remove a buddy from your list (or if the connection to that user drops) and there's still data in the buffer, this data will be lost. BitlBee will not try to send the message to the user in those cases.
    474                         </para>
    475                 </description>
    476 
    477         </bitlbee-setting>
    478 
    479         <bitlbee-setting name="buddy_sendbuffer_delay" type="integer">
    480                 <default>200</default>
    481 
    482                 <description>
    483 
    484                         <para>
    485                                 Tell BitlBee after how many (mili)seconds a buffered message should be sent. Values greater than 5 will be interpreted as miliseconds, 5 and lower as seconds.
    486                         </para>
    487 
    488                         <para>
    489                                 See also the <emphasis>buddy_sendbuffer</emphasis> setting.
    490                         </para>
    491                 </description>
    492 
    493         </bitlbee-setting>
    494 
    495         <bitlbee-setting name="default_target" type="string">
    496                 <default>root</default>
    497                 <possible-values>root, last</possible-values>
    498 
    499                 <description>
    500                         <para>
    501                                 With this value set to <emphasis>root</emphasis>, lines written in the control channel without any nickname in front of them will be interpreted as commands. If you want BitlBee to send those lines to the last person you addressed in the control channel, set this to <emphasis>last</emphasis>.
    502                         </para>
    503                 </description>
    504 
    505         </bitlbee-setting>
    506 
    507         <bitlbee-setting name="display_namechanges" type="boolean">
    508                 <default>False</default>
    509 
    510                 <para>
    511                         With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name".
    512                 </para>
    513         </bitlbee-setting>
    514 
    515         <bitlbee-setting name="password" type="string">
    516                 <description>
    517                         <para>
    518                                 Use this setting to change your "NickServ" password.
    519                         </para>
    520                 </description>
    521         </bitlbee-setting>
    522 
    523         <bitlbee-setting name="query_order" type="string">
     462        <bitlbee-setting name="lcnicks" type="boolean" scope="global">
     463                <default>true</default>
     464
     465                <description>
     466                        <para>
     467                                Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
     468                        </para>
     469                </description>
     470
     471        </bitlbee-setting>
     472
     473        <bitlbee-setting name="mail_notifications" type="boolean" scope="account">
     474                <default>false</default>
     475
     476                <description>
     477                        <para>
     478                                Some protocols (MSN, Yahoo!) can notify via IM about new e-mail. Since most people use their Hotmail/Yahoo! addresses as a spam-box, this is disabled default. If you want these notifications, you can enable this setting.
     479                        </para>
     480                </description>
     481
     482        </bitlbee-setting>
     483
     484        <bitlbee-setting name="ops" type="string" scope="global">
     485                <default>both</default>
     486                <possible-values>both, root, user, none</possible-values>
     487
     488                <description>
     489                        <para>
     490                                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.
     491                        </para>
     492
     493                        <para>
     494                                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.
     495                        </para>
     496                </description>
     497        </bitlbee-setting>
     498
     499        <bitlbee-setting name="password" type="string" scope="both">
     500                <description>
     501                        <para>
     502                                Use this global setting to change your "NickServ" password.
     503                        </para>
     504                       
     505                        <para>
     506                                This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service.
     507                        </para>
     508                       
     509                        <para>
     510                                Note that BitlBee will always say this setting is empty. This doesn't mean there is no password, it just means that, for security reasons, BitlBee stores passwords somewhere else so they can't just be retrieved in plain text.
     511                        </para>
     512                </description>
     513        </bitlbee-setting>
     514       
     515        <bitlbee-setting name="port" type="integer" scope="account">
     516                <description>
     517                        <para>
     518                                Currently only available for Jabber connections. Specifies the port number to connect to. Usually this should be set to 5222, or 5223 for SSL-connections.
     519                        </para>
     520                </description>
     521        </bitlbee-setting>
     522
     523        <bitlbee-setting name="priority" type="integer" scope="account">
     524                <default>0</default>
     525
     526                <description>
     527                        <para>
     528                                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).
     529                        </para>
     530
     531                        <para>
     532                                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).
     533                        </para>
     534                </description>
     535        </bitlbee-setting>
     536
     537        <bitlbee-setting name="private" type="boolean" scope="global">
     538                <default>true</default>
     539
     540                <description>
     541                        <para>
     542                                If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel.
     543                        </para>
     544
     545                        <para>
     546                                This setting is remembered (during one session) per-user, this setting only changes the default state. This option takes effect as soon as you reconnect.
     547                        </para>
     548                </description>
     549        </bitlbee-setting>
     550
     551        <bitlbee-setting name="query_order" type="string" scope="global">
    524552                <default>lifo</default>
    525553                <possible-values>lifo, fifo</possible-values>
    … …  
    536564        </bitlbee-setting>
    537565
    538         <bitlbee-setting name="lcnicks" type="boolean">
    539                 <default>True</default>
    540 
    541                 <description>
    542                         <para>
    543                                 Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer.
    544                         </para>
    545                 </description>
    546 
     566        <bitlbee-setting name="resource" type="string" scope="account">
     567                <default>BitlBee</default>
     568
     569                <description>
     570                        <para>
     571                                Can be set for Jabber connections. You can use this to connect to your Jabber account from multiple clients at once, with every client using a different resource string.
     572                        </para>
     573                </description>
     574        </bitlbee-setting>
     575
     576        <bitlbee-setting name="resource_select" type="string" scope="account">
     577                <default>priority</default>
     578                <possible-values>priority, time</possible-values>
     579
     580                <description>
     581                        <para>
     582                                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.
     583                        </para>
     584
     585                        <para>
     586                                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).
     587                        </para>
     588                </description>
     589        </bitlbee-setting>
     590
     591        <bitlbee-setting name="save_on_quit" type="boolean" scope="global">
     592                <default>true</default>
     593
     594                <description>
     595                        <para>
     596                                If enabled causes BitlBee to save all current settings and account details when user disconnects. This is enabled by default, and these days there's not really a reason to have it disabled anymore.
     597                        </para>
     598                </description>
     599        </bitlbee-setting>
     600
     601        <bitlbee-setting name="server" type="string" scope="account">
     602                <description>
     603                        <para>
     604                                Can be set for Jabber- and OSCAR-connections. For Jabber, you might have to set this if the servername isn't equal to the part after the @ in the Jabber handle. For OSCAR this shouldn't be necessary anymore in recent BitlBee versions.
     605                        </para>
     606                </description>
     607        </bitlbee-setting>
     608
     609        <bitlbee-setting name="simulate_netsplit" type="boolean" scope="global">
     610                <default>true</default>
     611
     612                <description>
     613                        <para>
     614                                Some IRC clients parse quit messages sent by the IRC server to see if someone really left or just disappeared because of a netsplit. By default, BitlBee tries to simulate netsplit-like quit messages to keep the control channel window clean. If you don't like this (or if your IRC client doesn't support this) you can disable this setting.
     615                        </para>
     616                </description>
     617        </bitlbee-setting>
     618
     619        <bitlbee-setting name="ssl" type="boolean" scope="account">
     620                <default>false</default>
     621
     622                <description>
     623                        <para>
     624                                Currently only available for Jabber connections. Set this to true if the server accepts SSL connections.
     625                        </para>
     626                </description>
     627        </bitlbee-setting>
     628
     629        <bitlbee-setting name="strip_html" type="boolean" scope="global">
     630                <default>true</default>
     631
     632                <description>
     633                        <para>
     634                                Determines what BitlBee should do with HTML in messages. Normally this is turned on and HTML will be stripped from messages, if BitlBee thinks there is HTML.
     635                        </para>
     636                        <para>
     637                                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.
     638                        </para>
     639                </description>
     640        </bitlbee-setting>
     641
     642        <bitlbee-setting name="tls" type="boolean" scope="account">
     643                <default>try</default>
     644
     645                <description>
     646                        <para>
     647                                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.
     648                        </para>
     649
     650                        <para>
     651                                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.
     652                        </para>
     653                </description>
     654        </bitlbee-setting>
     655
     656        <bitlbee-setting name="to_char" type="string" scope="global">
     657                <default>": "</default>
     658
     659                <description>
     660                        <para>
     661                                It's customary that messages meant for one specific person on an IRC channel are prepended by his/her alias followed by a colon ':'. BitlBee does this by default. If you prefer a different character, you can set it using <emphasis>set to_char</emphasis>.
     662                        </para>
     663
     664                        <para>
     665                                Please note that this setting is only used for incoming messages. For outgoing messages you can use ':' (colon) or ',' to separate the destination nick from the message, and this is not configurable.
     666                        </para>
     667                </description>
     668        </bitlbee-setting>
     669
     670        <bitlbee-setting name="typing_notice" type="boolean" scope="global">
     671                <default>false</default>
     672
     673                <description>
     674                        <para>
     675                                Sends you a /notice when a user starts typing a message (if supported by the IM protocol and the user's client). To use this, you most likely want to use a script in your IRC client to show this information in a more sensible way.
     676                        </para>
     677                </description>
     678        </bitlbee-setting>
     679
     680        <bitlbee-setting name="web_aware" type="string" scope="account">
     681                <default>false</default>
     682
     683                <description>
     684                        <para>
     685                                ICQ allows people to see if you're on-line via a CGI-script. (http://status.icq.com/online.gif?icq=UIN) This can be nice to put on your website, but it seems that spammers also use it to see if you're online without having to add you to their contact list. So to prevent ICQ spamming, recent versions of BitlBee disable this feature by default.
     686                        </para>
     687
     688                        <para>
     689                                Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled.
     690                        </para>
     691                </description>
     692        </bitlbee-setting>
     693
     694        <bitlbee-setting name="xmlconsole" type="boolean" scope="account">
     695                <default>false</default>
     696
     697                <description>
     698                        <para>
     699                                The Jabber module allows you to add a buddy <emphasis>xmlconsole</emphasis> to your contact list, which will then show you the raw XMPP stream between you and the server. You can also send XMPP packets to this buddy, which will then be sent to the server.
     700                        </para>
     701                        <para>
     702                                If you want to enable this XML console permanently (and at login time already), you can set this setting.
     703                        </para>
     704                </description>
    547705        </bitlbee-setting>
    548706
    … …  
    668826                <short-description>Change friendly name, nick</short-description>
    669827                <syntax>nick &lt;connection&gt; [&lt;new nick&gt;]</syntax>
    670                 <syntax>nick</syntax>
    671 
    672                 <description>
    673                         <para>
    674                                 This command allows to set the friendly name of an im account. If no new name is specified the command will report the current name. When the name contains spaces, don't forget to quote the whole nick in double quotes. Currently this command is only supported by the MSN protocol.
     828                <syntax>nick &lt;connection&gt;</syntax>
     829
     830                <description>
     831                        <para>
     832                                Deprecated: Use the per-account <emphasis>display_name</emphasis> setting to read and change this information.
    675833                        </para>
    676834                </description>
    677835
    678836                <ircexample>
    679                         <ircline nick="wouter">nick 1 "Wouter Paesen"</ircline>
    680                         <ircline nick="root">Setting your name on connection 1 to `Wouter Paesen'</ircline>
     837                        <ircline nick="wouter">account set 1/display_name "The majestik møøse"</ircline>
     838                        <ircline nick="root">display_name = `The majestik møøse'</ircline>
    681839                </ircexample>
    682840
    683841        </bitlbee-command>
    684842
    685         <bitlbee-command name="import_buddies">
    686                 <short-description>Copy local buddy list to server (normally only needed when upgrading)</short-description>
    687                 <syntax>import_buddies &lt;connection&gt; [clear]</syntax>
    688 
    689                 <description>
    690                         <para>
    691                                 This command copies the locally stored buddy list to the server. This command exists for upgrading purposes. Previous versions of BitlBee didn't support server-side buddy lists for ICQ, so the list was stored locally.
    692                         </para>
    693 
    694                         <para>
    695                                 Since version 0.91 however, server-side contact lists are supported for all protocols, so the local list is now ignored. When upgrading from an older BitlBee to version 0.91, you might need this command to get your buddy list back.
    696                         </para>
    697 
    698                         <para>
    699                                 The only argument this command needs is your ICQ account identification. If your serverside buddy list contains some old buddies you don't want anymore, you can pass <emphasis>clear</emphasis> as a second argument.
    700                         </para>
    701 
    702                         <para>
    703                                 After giving this command, you have to wait for a while before all the adds are handled, because of ICQ's rate limiting. If your buddy list is very large and the ICQ server starts complaining, you might have to reconnect and enter this command again.
    704                         </para>
    705                 </description>
     843        <bitlbee-command name="join_chat">
     844                <short-description>Join a named groupchat/conference room</short-description>
     845                <syntax>join_chat &lt;connection&gt; &lt;room name&gt; [&lt;channel name&gt;] [&lt;room nickname&gt;] [&lt;password&gt;]</syntax>
     846
     847                <description>
     848                        <para>
     849                                On most IM-networks groupchats can be started using the /join command. (<emphasis>/join #foo</emphasis> to start a chatroom with you and <emphasis>foo</emphasis>) This doesn't work with names groupchats though (which exist on Jabber networks and AIM, for example), instead you can use this command.
     850                        </para>
     851
     852                        <para>
     853                                The first two arguments are required. <emphasis>room name</emphasis> is the name of the chatroom on the IM-network. <emphasis>channel name</emphasis> is the IRC channel name BitlBee should map this to. <emphasis>room nickname</emphasis> is the nickname you want to have in this channel. If you don't give these options, BitlBee will do the right guesses.
     854                        </para>
     855
     856                        <para>
     857                                The following command will join you to the chatroom called <emphasis>bitlbee@conference.bitlbee.org</emphasis>. The channel will be called <emphasis>&amp;bitlbee-help</emphasis> because <emphasis>&amp;bitlbee</emphasis> will already be in use. Your nickname will be <emphasis>help-me</emphasis>.
     858                        </para>
     859                </description>
     860
     861                <ircexample>
     862                        <ircline nick="wilmer">join_chat jabber bitlbee@conference.bitlbee.org &amp;bitlbee-help help-me</ircline>
     863                </ircexample>
    706864
    707865        </bitlbee-command>
Note: See TracChangeset for help on using the changeset viewer.