Changes in doc/user-guide/commands.xml [75a4b85:64d1f45]
- File:
-
- 1 edited
-
doc/user-guide/commands.xml (modified) (12 diffs)
Legend:
- Unmodified
- Added
- Removed
-
doc/user-guide/commands.xml
r75a4b85 r64d1f45 11 11 12 12 <para> 13 Available actions: add, del, list, on, off and set. See <emphasis>help account <action></emphasis> for more information.13 Available actions: add, del, list, on, off. 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 @server.tld> <password> [<servertag>]</syntax>28 <syntax>account add jabber <handle> <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]]. 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: 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: 39 33 </para> 40 34 </description> … … 44 38 <ircline nick="root">Account successfully added</ircline> 45 39 </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 @server.tld> <password></syntax>49 <syntax>account add msn <handle> <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 that have the auto_connect flag set.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) 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 and cancel all pending reconnects.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) 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.155 135 </para> 156 136 </description> … … 296 276 </bitlbee-command> 297 277 298 <bitlbee-setting name="auto_connect" type="boolean">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">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 </description>324 325 </bitlbee-setting>326 327 <bitlbee-setting name="auto_reconnect_delay" type="integer">328 <default>300</default>329 330 <description>331 <para>332 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.333 </para>334 335 <para>336 See also the <emphasis>auto_reconnect</emphasis> setting.337 </para>338 </description>339 </bitlbee-setting>340 341 <bitlbee-setting name="away_devoice" type="boolean">342 <default>True</default>343 344 <description>345 <para>346 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.347 </para>348 </description>349 </bitlbee-setting>350 351 <bitlbee-setting name="buddy_sendbuffer" type="boolean">352 <default>False</default>353 354 <description>355 <para>356 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.357 </para>358 359 <para>360 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.361 </para>362 363 <para>364 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.365 </para>366 </description>367 </bitlbee-setting>368 369 <bitlbee-setting name="buddy_sendbuffer_delay" type="integer">370 <default>200</default>371 372 <description>373 374 <para>375 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.376 </para>377 378 <para>379 See also the <emphasis>buddy_sendbuffer</emphasis> setting.380 </para>381 </description>382 </bitlbee-setting>383 384 278 <bitlbee-setting name="charset" type="string"> 385 279 <default>iso8859-1</default> … … 398 292 </bitlbee-setting> 399 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 400 332 <bitlbee-setting name="debug" type="boolean"> 401 333 <default>False</default> … … 408 340 </bitlbee-setting> 409 341 410 <bitlbee-setting name="default_target" type="string"> 411 <default>root</default> 412 <possible-values>root, last</possible-values> 413 414 <description> 415 <para> 416 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>. 417 </para> 418 </description> 419 </bitlbee-setting> 420 421 <bitlbee-setting name="display_name" type="string"> 422 <description> 423 <para> 424 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. 425 </para> 426 </description> 427 </bitlbee-setting> 428 429 <bitlbee-setting name="display_namechanges" type="boolean"> 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"> 430 358 <default>False</default> 431 359 432 <para> 433 With this option enabled, root will inform you when someone in your buddy list changes his/her "friendly name". 434 </para> 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> 435 390 </bitlbee-setting> 436 391 … … 462 417 </bitlbee-setting> 463 418 464 <bitlbee-setting name=" lcnicks" type="boolean">419 <bitlbee-setting name="auto_connect" type="boolean"> 465 420 <default>True</default> 466 421 467 422 <description> 468 423 <para> 469 Hereby you can change whether you want all lower case nick names or leave the case as it intended by your peer. 470 </para> 471 </description> 472 473 </bitlbee-setting> 474 475 <bitlbee-setting name="ops" type="string"> 476 <default>both</default> 477 <possible-values>both, root, user, none</possible-values> 478 479 <description> 480 <para> 481 Some people prefer themself and root to have operator status in &bitlbee, other people don't. You can change these states using this setting. 482 </para> 483 484 <para> 485 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. 486 </para> 487 </description> 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> 488 513 </bitlbee-setting> 489 514 … … 491 516 <description> 492 517 <para> 493 Use this global setting to change your "NickServ" password. 494 </para> 495 496 <para> 497 This setting is also available for all IM accounts to change the password BitlBee uses to connect to the service. 498 </para> 499 500 <para> 501 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. 502 </para> 503 </description> 504 </bitlbee-setting> 505 506 <bitlbee-setting name="port" type="integer"> 507 <description> 508 <para> 509 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. 510 </para> 511 </description> 512 </bitlbee-setting> 513 514 <bitlbee-setting name="private" type="boolean"> 515 <default>True</default> 516 517 <description> 518 <para> 519 If value is true, messages from users will appear in separate query windows. If false, messages from users will appear in the control channel. 520 </para> 521 522 <para> 523 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. 518 Use this setting to change your "NickServ" password. 524 519 </para> 525 520 </description> … … 541 536 </bitlbee-setting> 542 537 543 <bitlbee-setting name="resource" type="string"> 544 <default>BitlBee</default> 545 546 <description> 547 <para> 548 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. 549 </para> 550 </description> 551 </bitlbee-setting> 552 553 <bitlbee-setting name="save_on_quit" type="boolean"> 538 <bitlbee-setting name="lcnicks" type="boolean"> 554 539 <default>True</default> 555 540 556 541 <description> 557 542 <para> 558 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. 559 </para> 560 </description> 561 </bitlbee-setting> 562 563 <bitlbee-setting name="server" type="string"> 564 <description> 565 <para> 566 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. 567 </para> 568 </description> 569 </bitlbee-setting> 570 571 <bitlbee-setting name="ssl" type="boolean"> 572 <default>False</default> 573 574 <description> 575 <para> 576 Currently only available for Jabber connections. Set this to true if the server accepts SSL connections. 577 </para> 578 </description> 579 </bitlbee-setting> 580 581 <bitlbee-setting name="strip_html" type="boolean"> 582 <default>True</default> 583 584 <description> 585 <para> 586 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. 587 </para> 588 <para> 589 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. 590 </para> 591 </description> 592 </bitlbee-setting> 593 594 <bitlbee-setting name="to_char" type="string"> 595 <default>": "</default> 596 597 <description> 598 <para> 599 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>. 600 </para> 601 602 <para> 603 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. 604 </para> 605 </description> 606 </bitlbee-setting> 607 608 <bitlbee-setting name="typing_notice" type="boolean"> 609 <default>False</default> 610 611 <description> 612 <para> 613 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. ;-) 614 </para> 615 </description> 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 616 547 </bitlbee-setting> 617 548
Note: See TracChangeset
for help on using the changeset viewer.
