Changeset 6197702 for doc/user-guide/commands.xml
- Timestamp:
- 2010-10-09T18:41:19Z (14 years ago)
- Branches:
- master
- Children:
- d150a9d
- Parents:
- 23b29c6 (diff), 27b407f (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
-
doc/user-guide/commands.xml (modified) (3 diffs)
Legend:
- Unmodified
- Added
- Removed
-
doc/user-guide/commands.xml
r23b29c6 r6197702 367 367 </description> 368 368 </bitlbee-command> 369 370 <bitlbee-command name="otr"> 371 <short-description>Off-the-Record encryption control</short-description> 372 <syntax>otr <subcommand> [<arguments>]</syntax> 373 374 <description> 375 376 <para> 377 Available subcommands: connect, disconnect, smp, smpq, trust, info, keygen, and forget. See <emphasis>help otr <subcommand></emphasis> for more information. 378 </para> 379 380 </description> 381 382 <bitlbee-command name="connect"> 383 <syntax>otr connect <nick></syntax> 384 385 <description> 386 387 <para> 388 Attempts to establish an encrypted connection with the specified user by sending a magic string. 389 </para> 390 391 </description> 392 393 </bitlbee-command> 394 395 <bitlbee-command name="disconnect"> 396 <syntax>otr disconnect <nick></syntax> 397 398 <description> 399 400 <para> 401 Resets the connection with the specified user to cleartext. 402 </para> 403 404 </description> 405 406 </bitlbee-command> 407 408 <bitlbee-command name="smp"> 409 <syntax>otr smp <nick> <secret></syntax> 410 411 <description> 412 413 <para> 414 Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol. 415 </para> 416 417 <para> 418 If an SMP challenge has been received from the given user, responds with the specified secret/answer. Otherwise, sends a challenge for the given secret. 419 </para> 420 421 <para> 422 Note that there are two flavors of SMP challenges: "shared-secret" and "question & answer". This command is used to respond to both of them, or to initiate a shared-secret style exchange. Use the <emphasis>otr smpq</emphasis> command to initiate a "Q&A" session. 423 </para> 424 425 <para> 426 When responding to a "Q&A" challenge, the local trust value is not altered. Only the <emphasis>asking party</emphasis> sets trust in the case of success. Use <emphasis>otr smpq</emphasis> to pose your challenge. In a shared-secret exchange, both parties set their trust according to the outcome. 427 </para> 428 429 </description> 430 431 </bitlbee-command> 432 433 <bitlbee-command name="smpq"> 434 <syntax>otr smpq <nick> <question> <answer></syntax> 435 436 <description> 437 438 <para> 439 Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol, Q&A style. 440 </para> 441 442 <para> 443 Initiates an SMP session in "question & answer" style. The question is transmitted with the initial SMP packet and used to prompt the other party. You must be confident that only they know the answer. If the protocol succeeds (i.e. they answer correctly), the fingerprint will be trusted. Note that the answer must be entered exactly, case and punctuation count! 444 </para> 445 446 <para> 447 Note that this style of SMP only affects the trust setting on your side. Expect your opponent to send you their own challenge. Alternatively, if you and the other party have a shared secret, use the <emphasis>otr smp</emphasis> command. 448 </para> 449 450 </description> 451 452 </bitlbee-command> 453 454 <bitlbee-command name="trust"> 455 <syntax>otr trust <nick> <fp1> <fp2> <fp3> <fp4> <fp5></syntax> 456 457 <description> 458 459 <para> 460 Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each. 461 </para> 462 463 </description> 464 465 </bitlbee-command> 466 467 <bitlbee-command name="info"> 468 <syntax>otr info</syntax> 469 <syntax>otr info <nick></syntax> 470 471 <description> 472 473 <para> 474 Shows information about the OTR state. The first form lists our private keys and current OTR contexts. The second form displays information about the connection with a given user, including the list of their known fingerprints. 475 </para> 476 477 </description> 478 479 </bitlbee-command> 480 481 <bitlbee-command name="keygen"> 482 <syntax>otr keygen <account-no></syntax> 483 484 <description> 485 486 <para> 487 Generates a new OTR private key for the given account. 488 </para> 489 490 </description> 491 492 </bitlbee-command> 493 494 <bitlbee-command name="forget"> 495 <syntax>otr forget <thing> <arguments></syntax> 496 497 <description> 498 499 <para> 500 Forgets some part of our OTR userstate. Available things: fingerprint, context, and key. See <emphasis>help otr forget <thing></emphasis> for more information. 501 </para> 502 503 </description> 504 505 <bitlbee-command name="fingerprint"> 506 <syntax>otr forget fingerprint <nick> <fingerprint></syntax> 507 508 <description> 509 510 <para> 511 Drops the specified fingerprint from the given user's OTR connection context. It is allowed to specify only a (unique) prefix of the desired fingerprint. 512 </para> 513 514 </description> 515 516 </bitlbee-command> 517 518 <bitlbee-command name="context"> 519 <syntax>otr forget context <nick></syntax> 520 521 <description> 522 523 <para> 524 Forgets the entire OTR context associated with the given user. This includes current message and protocol states, as well as any fingerprints for that user. 525 </para> 526 527 </description> 528 529 </bitlbee-command> 530 531 <bitlbee-command name="key"> 532 <syntax>otr forget key <fingerprint></syntax> 533 534 <description> 535 536 <para> 537 Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint. 538 </para> 539 540 </description> 541 542 </bitlbee-command> 543 544 </bitlbee-command> 545 546 </bitlbee-command> 369 547 370 548 <bitlbee-command name="set"> … … 589 767 </description> 590 768 769 </bitlbee-setting> 770 771 <bitlbee-setting name="color_encrypted" type="boolean" scope="global"> 772 <default>true</default> 773 774 <description> 775 <para> 776 If set to true, BitlBee will color incoming encrypted messages according to their fingerprint trust level: untrusted=red, trusted=green. 777 </para> 778 </description> 591 779 </bitlbee-setting> 592 780 … … 931 1119 </bitlbee-setting> 932 1120 1121 <bitlbee-setting name="otr_policy" type="string" scope="global"> 1122 <default>opportunistic</default> 1123 <possible-values>never, opportunistic, manual, always</possible-values> 1124 1125 <description> 1126 <para> 1127 This setting controls the policy for establishing Off-the-Record connections. 1128 </para> 1129 <para> 1130 A value of "never" effectively disables the OTR subsystem. In "opportunistic" mode, a magic whitespace pattern will be appended to the first message sent to any user. If the peer is also running opportunistic OTR, an encrypted connection will be set up automatically. On "manual", on the other hand, OTR connections must be established explicitly using <emphasis>otr connect</emphasis>. Finally, the setting "always" enforces encrypted communication by causing BitlBee to refuse to send any cleartext messages at all. 1131 </para> 1132 </description> 1133 </bitlbee-setting> 1134 933 1135 <bitlbee-setting name="password" type="string" scope="both"> 934 1136 <description>
Note: See TracChangeset
for help on using the changeset viewer.
