Changeset 69cb623 for doc/user-guide/commands.xml
- Timestamp:
- 2006-10-15T09:41:12Z (17 years ago)
- Branches:
- master
- Children:
- 2529faf
- Parents:
- 695e392 (diff), e97827b (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. - File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
doc/user-guide/commands.xml
r695e392 r69cb623 11 11 12 12 <para> 13 Available actions: add, del, list, on, off . See <emphasis>help account <action></emphasis> for more information.13 Available actions: add, del, list, on, off and set. See <emphasis>help account <action></emphasis> for more information. 14 14 </para> 15 15 … … 26 26 27 27 <bitlbee-command name="jabber"> 28 <syntax>account add jabber <handle > <password> [<servertag>]</syntax>28 <syntax>account add jabber <handle@server.tld> <password> [<servertag>]</syntax> 29 29 30 30 <description> 31 31 <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: [<servername>[:<portnumber>][:ssl]]. For example, this is how you can connect to Google Talk: 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: [<servername>[:<portnumber>][:ssl]]. 33 </para> 34 </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: 33 39 </para> 34 40 </description> … … 38 44 <ircline nick="root">Account successfully added</ircline> 39 45 </ircexample> 40 41 <description>42 <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.44 </para>45 </description>46 46 </bitlbee-command> 47 47 48 48 <bitlbee-command name="msn"> 49 <syntax>account add msn <handle > <password></syntax>49 <syntax>account add msn <handle@server.tld> <password></syntax> 50 50 51 51 <description> … … 103 103 <description> 104 104 <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)105 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. 106 106 </para> 107 107 … … 118 118 <description> 119 119 <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)120 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. 121 121 </para> 122 122 … … 133 133 <para> 134 134 This command gives you a list of all the accounts known by BitlBee, including the numbers you'll need for most account commands. 135 </para> 136 </description> 137 </bitlbee-command> 138 139 <bitlbee-command name="set"> 140 <syntax>account set <account id></syntax> 141 <syntax>account set <account id>/<setting></syntax> 142 <syntax>account set <account id>/<setting> <value></syntax> 143 144 <description> 145 <para> 146 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 <account id></emphasis>. 147 </para> 148 149 <para> 150 For more infomation about a setting, see <emphasis>help set <setting></emphasis>. 151 </para> 152 153 <para> 154 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. 135 155 </para> 136 156 </description> … … 276 296 </bitlbee-command> 277 297 278 <bitlbee-setting name="charset" type="string"> 298 <bitlbee-setting name="auto_connect" type="boolean" scope="both"> 299 <default>true</default> 300 301 <description> 302 <para> 303 With this option enabled, when you identify BitlBee will automatically connect to your accounts, with this disabled it will not do this. 304 </para> 305 306 <para> 307 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!) 308 </para> 309 </description> 310 </bitlbee-setting> 311 312 <bitlbee-setting name="auto_reconnect" type="boolean" scope="both"> 313 <default>false</default> 314 315 <description> 316 <para> 317 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. 318 </para> 319 320 <para> 321 See also the <emphasis>auto_reconnect_delay</emphasis> setting. 322 </para> 323 324 <para> 325 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!) 326 </para> 327 </description> 328 </bitlbee-setting> 329 330 <bitlbee-setting name="auto_reconnect_delay" type="integer" scope="global"> 331 <default>300</default> 332 333 <description> 334 <para> 335 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. 336 </para> 337 338 <para> 339 See also the <emphasis>auto_reconnect</emphasis> setting. 340 </para> 341 </description> 342 </bitlbee-setting> 343 344 <bitlbee-setting name="away_devoice" type="boolean" scope="global"> 345 <default>true</default> 346 347 <description> 348 <para> 349 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. 350 </para> 351 </description> 352 </bitlbee-setting> 353 354 <bitlbee-setting name="buddy_sendbuffer" type="boolean" scope="global"> 355 <default>false</default> 356 357 <description> 358 <para> 359 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. 360 </para> 361 362 <para> 363 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. 364 </para> 365 366 <para> 367 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. 368 </para> 369 </description> 370 </bitlbee-setting> 371 372 <bitlbee-setting name="buddy_sendbuffer_delay" type="integer" scope="global"> 373 <default>200</default> 374 375 <description> 376 377 <para> 378 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. 379 </para> 380 381 <para> 382 See also the <emphasis>buddy_sendbuffer</emphasis> setting. 383 </para> 384 </description> 385 </bitlbee-setting> 386 387 <bitlbee-setting name="charset" type="string" scope="global"> 279 388 <default>iso8859-1</default> 280 389 <possible-values>you can get a list of all possible values by doing 'iconv -l' in a shell</possible-values> … … 292 401 </bitlbee-setting> 293 402 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> 403 <bitlbee-setting name="debug" type="boolean" scope="global"> 404 <default>false</default> 334 405 335 406 <description> … … 340 411 </bitlbee-setting> 341 412 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 &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"> 413 <bitlbee-setting name="default_target" type="string" scope="global"> 414 <default>root</default> 415 <possible-values>root, last</possible-values> 416 417 <description> 418 <para> 419 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>. 420 </para> 421 </description> 422 </bitlbee-setting> 423 424 <bitlbee-setting name="display_name" type="string" scope="account"> 425 <description> 426 <para> 427 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. 428 </para> 429 </description> 430 </bitlbee-setting> 431 432 <bitlbee-setting name="display_namechanges" type="boolean" scope="global"> 433 <default>false</default> 434 435 <para> 436 With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name". 437 </para> 438 </bitlbee-setting> 439 440 <bitlbee-setting name="handle_unknown" type="string" scope="global"> 393 441 <default>root</default> 394 442 <possible-values>root, add, add_private, add_channel, ignore</possible-values> … … 417 465 </bitlbee-setting> 418 466 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"> 467 <bitlbee-setting name="lcnicks" type="boolean" scope="global"> 468 <default>true</default> 469 470 <description> 471 <para> 472 Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer. 473 </para> 474 </description> 475 476 </bitlbee-setting> 477 478 <bitlbee-setting name="ops" type="string" scope="global"> 479 <default>both</default> 480 <possible-values>both, root, user, none</possible-values> 481 482 <description> 483 <para> 484 Some people prefer themself and root to have operator status in &bitlbee, other people don't. You can change these states using this setting. 485 </para> 486 487 <para> 488 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. 489 </para> 490 </description> 491 </bitlbee-setting> 492 493 <bitlbee-setting name="password" type="string" scope="both"> 494 <description> 495 <para> 496 Use this global setting to change your "NickServ" password. 497 </para> 498 499 <para> 500 This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service. 501 </para> 502 503 <para> 504 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. 505 </para> 506 </description> 507 </bitlbee-setting> 508 509 <bitlbee-setting name="port" type="integer" scope="account"> 510 <description> 511 <para> 512 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. 513 </para> 514 </description> 515 </bitlbee-setting> 516 517 <bitlbee-setting name="private" type="boolean" scope="global"> 518 <default>true</default> 519 520 <description> 521 <para> 522 If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel. 523 </para> 524 525 <para> 526 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. 527 </para> 528 </description> 529 </bitlbee-setting> 530 531 <bitlbee-setting name="query_order" type="string" scope="global"> 524 532 <default>lifo</default> 525 533 <possible-values>lifo, fifo</possible-values> … … 536 544 </bitlbee-setting> 537 545 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 546 <bitlbee-setting name="resource" type="string" scope="account"> 547 <default>BitlBee</default> 548 549 <description> 550 <para> 551 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. 552 </para> 553 </description> 554 </bitlbee-setting> 555 556 <bitlbee-setting name="save_on_quit" type="boolean" scope="global"> 557 <default>true</default> 558 559 <description> 560 <para> 561 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. 562 </para> 563 </description> 564 </bitlbee-setting> 565 566 <bitlbee-setting name="server" type="string" scope="account"> 567 <description> 568 <para> 569 Can be set for Jabber- and OSCAR-connections. For OSCAR, this must be set to <emphasis>login.icq.com</emphasis> if it's an ICQ connection, or <emphasis>login.oscar.aol.com</emphasis> if it's an AIM connection. For Jabber, you have to set this if the servername isn't equal to the part after the @ in the Jabber handle. 570 </para> 571 </description> 572 </bitlbee-setting> 573 574 <bitlbee-setting name="ssl" type="boolean" scope="account"> 575 <default>false</default> 576 577 <description> 578 <para> 579 Currently only available for Jabber connections. Set this to true if the server accepts SSL connections. 580 </para> 581 </description> 582 </bitlbee-setting> 583 584 <bitlbee-setting name="strip_html" type="boolean" scope="global"> 585 <default>true</default> 586 587 <description> 588 <para> 589 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. 590 </para> 591 <para> 592 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. 593 </para> 594 </description> 595 </bitlbee-setting> 596 597 <bitlbee-setting name="to_char" type="string" scope="global"> 598 <default>": "</default> 599 600 <description> 601 <para> 602 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>. 603 </para> 604 605 <para> 606 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. 607 </para> 608 </description> 609 </bitlbee-setting> 610 611 <bitlbee-setting name="typing_notice" type="boolean" scope="global"> 612 <default>false</default> 613 614 <description> 615 <para> 616 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. ;-) 617 </para> 618 </description> 619 </bitlbee-setting> 620 621 <bitlbee-setting name="web_aware" type="string" scope="account"> 622 <default>false</default> 623 624 <description> 625 <para> 626 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. 627 </para> 628 629 <para> 630 Unless you really intend to use this feature somewhere (on forums or maybe a website), it's probably better to keep this setting disabled. 631 </para> 632 </description> 547 633 </bitlbee-setting> 548 634 … … 674 760 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. 675 761 </para> 762 763 <para> 764 It is recommended to use the per-account <emphasis>display_name</emphasis> setting to read and change this information. The <emphasis>nick</emphasis> command is deprecated. 765 </para> 676 766 </description> 677 767
Note: See TracChangeset
for help on using the changeset viewer.