Changeset be999a5 for doc/user-guide
- Timestamp:
- 2010-08-23T23:12:24Z (14 years ago)
- Branches:
- master
- Children:
- ad2d8bc
- Parents:
- 237eadd (diff), eb6df6a (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
r237eadd rbe999a5 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="trust"> 426 <syntax>otr trust <nick> <fp1> <fp2> <fp3> <fp4> <fp5></syntax> 427 428 <description> 429 430 <para> 431 Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each. 432 </para> 433 434 </description> 435 436 </bitlbee-command> 437 438 <bitlbee-command name="info"> 439 <syntax>otr info</syntax> 440 <syntax>otr info <nick></syntax> 441 442 <description> 443 444 <para> 445 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. 446 </para> 447 448 </description> 449 450 </bitlbee-command> 451 452 <bitlbee-command name="keygen"> 453 <syntax>otr keygen <account-no></syntax> 454 455 <description> 456 457 <para> 458 Generates a new OTR private key for the given account. 459 </para> 460 461 </description> 462 463 </bitlbee-command> 464 465 <bitlbee-command name="forget"> 466 <syntax>otr forget <thing> <arguments></syntax> 467 468 <description> 469 470 <para> 471 Forgets some part of our OTR userstate. Available things: fingerprint, context, and key. See <emphasis>help otr forget <thing></emphasis> for more information. 472 </para> 473 474 </description> 475 476 <bitlbee-command name="fingerprint"> 477 <syntax>otr forget fingerprint <nick> <fingerprint></syntax> 478 479 <description> 480 481 <para> 482 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. 483 </para> 484 485 </description> 486 487 </bitlbee-command> 488 489 <bitlbee-command name="context"> 490 <syntax>otr forget context <nick></syntax> 491 492 <description> 493 494 <para> 495 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. 496 </para> 497 498 </description> 499 500 </bitlbee-command> 501 502 <bitlbee-command name="key"> 503 <syntax>otr forget key <fingerprint></syntax> 504 505 <description> 506 507 <para> 508 Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint. 509 </para> 510 511 </description> 512 513 </bitlbee-command> 514 515 </bitlbee-command> 516 517 </bitlbee-command> 369 518 370 519 <bitlbee-command name="set"> … … 589 738 </description> 590 739 740 </bitlbee-setting> 741 742 <bitlbee-setting name="color_encrypted" type="boolean" scope="global"> 743 <default>true</default> 744 745 <description> 746 <para> 747 If set to true, BitlBee will color incoming encrypted messages according to their fingerprint trust level: untrusted=red, trusted=green. 748 </para> 749 </description> 591 750 </bitlbee-setting> 592 751 … … 927 1086 </bitlbee-setting> 928 1087 1088 <bitlbee-setting name="otr_policy" type="string" scope="global"> 1089 <default>opportunistic</default> 1090 <possible-values>never, opportunistic, manual, always</possible-values> 1091 1092 <description> 1093 <para> 1094 This setting controls the policy for establishing Off-the-Record connections. 1095 </para> 1096 <para> 1097 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. 1098 </para> 1099 </description> 1100 </bitlbee-setting> 1101 929 1102 <bitlbee-setting name="password" type="string" scope="both"> 930 1103 <description>
Note: See TracChangeset
for help on using the changeset viewer.
