diff options
Diffstat (limited to 'doc/user-guide')
| -rw-r--r-- | doc/user-guide/commands.xml | 241 |
1 files changed, 234 insertions, 7 deletions
diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index af566de4..aa88eb3a 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -326,6 +326,155 @@ </para> </description> </bitlbee-command> + + <bitlbee-command name="otr"> + <short-description>Off-the-Record encryption control</short-description> + <syntax>otr <subcommand> [<arguments>]</syntax> + + <description> + + <para> + Available subcommands: connect, disconnect, smp, trust, info, keygen, and forget. See <emphasis>help otr <subcommand></emphasis> for more information. + </para> + + </description> + + <bitlbee-command name="connect"> + <syntax>otr connect <nick></syntax> + + <description> + + <para> + Attempts to establish an encrypted connection with the specified user by sending a magic string. + </para> + + </description> + + </bitlbee-command> + + <bitlbee-command name="disconnect"> + <syntax>otr disconnect <nick></syntax> + + <description> + + <para> + Resets the connection with the specified user to cleartext. + </para> + + </description> + + </bitlbee-command> + + <bitlbee-command name="smp"> + <syntax>otr smp <nick> <secret></syntax> + + <description> + + <para> + Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol. + </para> + + <para> + 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. + </para> + + </description> + + </bitlbee-command> + + <bitlbee-command name="trust"> + <syntax>otr trust <nick> <fp1> <fp2> <fp3> <fp4> <fp5></syntax> + + <description> + + <para> + Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each. + </para> + + </description> + + </bitlbee-command> + + <bitlbee-command name="info"> + <syntax>otr info</syntax> + <syntax>otr info <nick></syntax> + + <description> + + <para> + 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. + </para> + + </description> + + </bitlbee-command> + + <bitlbee-command name="keygen"> + <syntax>otr keygen <account-no></syntax> + + <description> + + <para> + Generates a new OTR private key for the given account. + </para> + + </description> + + </bitlbee-command> + + <bitlbee-command name="forget"> + <syntax>otr forget <thing> <arguments></syntax> + + <description> + + <para> + Forgets some part of our OTR userstate. Available things: fingerprint, context, and key. See <emphasis>help otr forget <thing></emphasis> for more information. + </para> + + </description> + + <bitlbee-command name="fingerprint"> + <syntax>otr forget fingerprint <nick> <fingerprint></syntax> + + <description> + + <para> + 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. + </para> + + </description> + + </bitlbee-command> + + <bitlbee-command name="context"> + <syntax>otr forget context <nick></syntax> + + <description> + + <para> + 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. + </para> + + </description> + + </bitlbee-command> + + <bitlbee-command name="key"> + <syntax>otr forget key <fingerprint></syntax> + + <description> + + <para> + Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint. + </para> + + </description> + + </bitlbee-command> + + </bitlbee-command> + + </bitlbee-command> <bitlbee-command name="set"> <short-description>Miscellaneous settings</short-description> @@ -494,6 +643,17 @@ </bitlbee-setting> + <bitlbee-setting name="color_encrypted" type="boolean" scope="global"> + <default>true</default> + + <description> + <para> + If set to true, BitlBee will color incoming encrypted messages according to their fingerprint trust level: untrusted=red, trusted=green. + </para> + </description> + + </bitlbee-setting> + <bitlbee-setting name="debug" type="boolean" scope="global"> <default>false</default> @@ -560,6 +720,22 @@ </bitlbee-setting> + <bitlbee-setting name="halfop_buddies" type="string" scope="global"> + <default>encrypted</default> + <possible-values>encrypted, trusted, notaway, false</possible-values> + + <description> + <para> + Specifies under which circumstances BitlBee should give the "halfop" mode flag (+h) to buddies. + </para> + + <para> + 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. + </para> + </description> + + </bitlbee-setting> + <bitlbee-setting name="lcnicks" type="boolean" scope="global"> <default>true</default> @@ -582,26 +758,61 @@ </bitlbee-setting> - <bitlbee-setting name="nick" type="string" scope="chat"> + <bitlbee-setting name="op_buddies" type="string" scope="global"> + <default>trusted</default> + <possible-values>encrypted, trusted, notaway, false</possible-values> <description> <para> - You can use this option to set your nickname in a chatroom. You won't see this nickname yourself, but other people in the room will. By default, BitlBee will use your username as the chatroom nickname. + Specifies under which circumstances BitlBee should give the "op" mode flag (+o) to buddies. + </para> + + <para> + 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. + </para> + </description> + + </bitlbee-setting> + + <bitlbee-setting name="op_root" type="bool" scope="global"> + <default>true</default> + + <description> + <para> + 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. </para> </description> </bitlbee-setting> - <bitlbee-setting name="ops" type="string" scope="global"> - <default>both</default> - <possible-values>both, root, user, none</possible-values> + <bitlbee-setting name="op_user" type="bool" scope="global"> + <default>true</default> <description> <para> - Some people prefer themself and root to have operator status in &bitlbee, other people don't. You can change these states using this setting. + 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. </para> + </description> + </bitlbee-setting> + <bitlbee-setting name="otr_policy" type="string" scope="global"> + <default>opportunistic</default> + <possible-values>never, opportunistic, manual, always</possible-values> + + <description> <para> - 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. + This setting controls the policy for establishing Off-the-Record connections. + </para> + <para> + 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. + </para> + </description> + </bitlbee-setting> + + <bitlbee-setting name="nick" type="string" scope="chat"> + + <description> + <para> + You can use this option to set your nickname in a chatroom. You won't see this nickname yourself, but other people in the room will. By default, BitlBee will use your username as the chatroom nickname. </para> </description> </bitlbee-setting> @@ -797,6 +1008,22 @@ </description> </bitlbee-setting> + <bitlbee-setting name="voice_buddies" type="string" scope="global"> + <default>trusted</default> + <possible-values>encrypted, trusted, notaway, false</possible-values> + + <description> + <para> + Specifies under which circumstances BitlBee should give the "voice" mode flag (+v) to buddies. + </para> + + <para> + 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. + </para> + </description> + + </bitlbee-setting> + <bitlbee-setting name="web_aware" type="string" scope="account"> <default>false</default> |