Changes in doc/user-guide/commands.xml [d0faf62:1febf5c]
- File:
-
- 1 edited
-
doc/user-guide/commands.xml (modified) (5 diffs)
Legend:
- Unmodified
- Added
- Removed
-
doc/user-guide/commands.xml
rd0faf62 r1febf5c 244 244 </description> 245 245 </bitlbee-command> 246 247 <bitlbee-command name="otr">248 <short-description>Off-the-Record encryption control</short-description>249 <syntax>otr <subcommand> [<arguments>]</syntax>250 251 <description>252 253 <para>254 Available subcommands: connect, disconnect, smp, trust, info, keygen, and forget. See <emphasis>help otr <subcommand></emphasis> for more information.255 </para>256 257 </description>258 259 <bitlbee-command name="connect">260 <syntax>otr connect <nick></syntax>261 262 <description>263 264 <para>265 Attempts to establish an encrypted connection with the specified user by sending a magic string.266 </para>267 268 </description>269 270 </bitlbee-command>271 272 <bitlbee-command name="disconnect">273 <syntax>otr disconnect <nick></syntax>274 275 <description>276 277 <para>278 Resets the connection with the specified user to cleartext.279 </para>280 281 </description>282 283 </bitlbee-command>284 285 <bitlbee-command name="smp">286 <syntax>otr smp <nick> <secret></syntax>287 288 <description>289 290 <para>291 Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol.292 </para>293 294 <para>295 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.296 </para>297 298 </description>299 300 </bitlbee-command>301 302 <bitlbee-command name="trust">303 <syntax>otr trust <nick> <fp1> <fp2> <fp3> <fp4> <fp5></syntax>304 305 <description>306 307 <para>308 Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each.309 </para>310 311 </description>312 313 </bitlbee-command>314 315 <bitlbee-command name="info">316 <syntax>otr info</syntax>317 <syntax>otr info <nick></syntax>318 319 <description>320 321 <para>322 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.323 </para>324 325 </description>326 327 </bitlbee-command>328 329 <bitlbee-command name="keygen">330 <syntax>otr keygen <account-no></syntax>331 332 <description>333 334 <para>335 Generates a new OTR private key for the given account.336 </para>337 338 </description>339 340 </bitlbee-command>341 342 <bitlbee-command name="forget">343 <syntax>otr forget <thing> <arguments></syntax>344 345 <description>346 347 <para>348 Forgets some part of our OTR userstate. Available things: fingerprint, context, and key. See <emphasis>help otr forget <thing></emphasis> for more information.349 </para>350 351 </description>352 353 <bitlbee-command name="fingerprint">354 <syntax>otr forget fingerprint <nick> <fingerprint></syntax>355 356 <description>357 358 <para>359 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.360 </para>361 362 </description>363 364 </bitlbee-command>365 366 <bitlbee-command name="context">367 <syntax>otr forget context <nick></syntax>368 369 <description>370 371 <para>372 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.373 </para>374 375 </description>376 377 </bitlbee-command>378 379 <bitlbee-command name="key">380 <syntax>otr forget key <fingerprint></syntax>381 382 <description>383 384 <para>385 Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint.386 </para>387 388 </description>389 390 </bitlbee-command>391 392 </bitlbee-command>393 394 </bitlbee-command>395 246 396 247 <bitlbee-command name="set"> … … 547 398 </bitlbee-setting> 548 399 549 <bitlbee-setting name="color_encrypted" type="boolean" scope="global">550 <default>true</default>551 552 <description>553 <para>554 If set to true, BitlBee will color incoming encrypted messages according to their fingerprint trust level: untrusted=red, trusted=green.555 </para>556 </description>557 558 </bitlbee-setting>559 560 400 <bitlbee-setting name="debug" type="boolean" scope="global"> 561 401 <default>false</default> … … 624 464 </bitlbee-setting> 625 465 626 <bitlbee-setting name="halfop_buddies" type="string" scope="global">627 <default>encrypted</default>628 <possible-values>encrypted, trusted, notaway, false</possible-values>629 630 <description>631 <para>632 Specifies under which circumstances BitlBee should give the "halfop" mode flag (+h) to buddies.633 </para>634 635 <para>636 If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key.637 </para>638 </description>639 640 </bitlbee-setting>641 642 466 <bitlbee-setting name="lcnicks" type="boolean" scope="global"> 643 467 <default>true</default> … … 662 486 </bitlbee-setting> 663 487 664 <bitlbee-setting name="op_buddies" type="string" scope="global"> 665 <default>trusted</default> 666 <possible-values>encrypted, trusted, notaway, false</possible-values> 667 668 <description> 669 <para> 670 Specifies under which circumstances BitlBee should give the "op" mode flag (+o) to buddies. 671 </para> 672 673 <para> 674 If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key. 675 </para> 676 </description> 677 678 </bitlbee-setting> 679 680 <bitlbee-setting name="op_root" type="bool" scope="global"> 681 <default>true</default> 682 683 <description> 684 <para> 685 Some people prefer themself and root to have operator status in &bitlbee, other people don't. You can set the desired state for root using this setting. 686 </para> 687 </description> 688 </bitlbee-setting> 689 690 <bitlbee-setting name="op_user" type="bool" scope="global"> 691 <default>true</default> 692 693 <description> 694 <para> 695 Some people prefer themself and root to have operator status in &bitlbee, other people don't. You can set the desired state for yourself using this setting. 696 </para> 697 </description> 698 </bitlbee-setting> 699 700 <bitlbee-setting name="otr_policy" type="string" scope="global"> 701 <default>opportunistic</default> 702 <possible-values>never, opportunistic, manual, always</possible-values> 703 704 <description> 705 <para> 706 This setting controls the policy for establishing Off-the-Record connections. 707 </para> 708 <para> 709 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. 488 <bitlbee-setting name="ops" type="string" scope="global"> 489 <default>both</default> 490 <possible-values>both, root, user, none</possible-values> 491 492 <description> 493 <para> 494 Some people prefer themself and root to have operator status in &bitlbee, other people don't. You can change these states using this setting. 495 </para> 496 497 <para> 498 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. 710 499 </para> 711 500 </description> … … 891 680 </para> 892 681 </description> 893 </bitlbee-setting>894 895 <bitlbee-setting name="voice_buddies" type="string" scope="global">896 <default>trusted</default>897 <possible-values>encrypted, trusted, notaway, false</possible-values>898 899 <description>900 <para>901 Specifies under which circumstances BitlBee should give the "voice" mode flag (+v) to buddies.902 </para>903 904 <para>905 If "false", the flag is never set. On "notaway", the flag is removed for users marked as "away" and set for all others. On "encrypted", the flag is set for users with whom we have an encrypted connection. On "trusted", it is set only for encrypted connections using a trusted key.906 </para>907 </description>908 909 682 </bitlbee-setting> 910 683
Note: See TracChangeset
for help on using the changeset viewer.
