Changes in doc/user-guide/commands.xml [2171044:c55701e]
- File:
-
- 1 edited
-
doc/user-guide/commands.xml (modified) (3 diffs)
Legend:
- Unmodified
- Added
- Removed
-
doc/user-guide/commands.xml
r2171044 rc55701e 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, 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 already been received from the given user, responds with the specified secret. Otherwise, a challenge for the secret will be sent. If the protocol succeeds (i.e. both parties gave the same secret), the fingerprint will be trusted.419 </para>420 421 </description>422 423 </bitlbee-command>424 425 <bitlbee-command name="smpq">426 <syntax>otr smpq <nick> <question> <answer></syntax>427 428 <description>429 430 <para>431 Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol, Q&A style.432 </para>433 434 <para>435 When initiating SMP, this is an alternative to the 'otr smp' command. The shared secret is provided as the answer to a specific question. The question is transmitted with the initial SMP packet and used to prompt the other party. If the protocol succeeds (i.e. they give the correct answer), the fingerprint will be trusted.436 </para>437 438 </description>439 440 </bitlbee-command>441 442 <bitlbee-command name="trust">443 <syntax>otr trust <nick> <fp1> <fp2> <fp3> <fp4> <fp5></syntax>444 445 <description>446 447 <para>448 Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each.449 </para>450 451 </description>452 453 </bitlbee-command>454 455 <bitlbee-command name="info">456 <syntax>otr info</syntax>457 <syntax>otr info <nick></syntax>458 459 <description>460 461 <para>462 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.463 </para>464 465 </description>466 467 </bitlbee-command>468 469 <bitlbee-command name="keygen">470 <syntax>otr keygen <account-no></syntax>471 472 <description>473 474 <para>475 Generates a new OTR private key for the given account.476 </para>477 478 </description>479 480 </bitlbee-command>481 482 <bitlbee-command name="forget">483 <syntax>otr forget <thing> <arguments></syntax>484 485 <description>486 487 <para>488 Forgets some part of our OTR userstate. Available things: fingerprint, context, and key. See <emphasis>help otr forget <thing></emphasis> for more information.489 </para>490 491 </description>492 493 <bitlbee-command name="fingerprint">494 <syntax>otr forget fingerprint <nick> <fingerprint></syntax>495 496 <description>497 498 <para>499 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.500 </para>501 502 </description>503 504 </bitlbee-command>505 506 <bitlbee-command name="context">507 <syntax>otr forget context <nick></syntax>508 509 <description>510 511 <para>512 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.513 </para>514 515 </description>516 517 </bitlbee-command>518 519 <bitlbee-command name="key">520 <syntax>otr forget key <fingerprint></syntax>521 522 <description>523 524 <para>525 Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint.526 </para>527 528 </description>529 530 </bitlbee-command>531 532 </bitlbee-command>533 534 </bitlbee-command>535 369 536 370 <bitlbee-command name="set"> … … 755 589 </description> 756 590 757 </bitlbee-setting>758 759 <bitlbee-setting name="color_encrypted" type="boolean" scope="global">760 <default>true</default>761 762 <description>763 <para>764 If set to true, BitlBee will color incoming encrypted messages according to their fingerprint trust level: untrusted=red, trusted=green.765 </para>766 </description>767 591 </bitlbee-setting> 768 592 … … 1107 931 </bitlbee-setting> 1108 932 1109 <bitlbee-setting name="otr_policy" type="string" scope="global">1110 <default>opportunistic</default>1111 <possible-values>never, opportunistic, manual, always</possible-values>1112 1113 <description>1114 <para>1115 This setting controls the policy for establishing Off-the-Record connections.1116 </para>1117 <para>1118 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.1119 </para>1120 </description>1121 </bitlbee-setting>1122 1123 933 <bitlbee-setting name="password" type="string" scope="both"> 1124 934 <description>
Note: See TracChangeset
for help on using the changeset viewer.
