From f5ac0fb078ee98bd836f1527dc90952f74ab0c18 Mon Sep 17 00:00:00 2001 From: Sven Moritz Hallberg Date: Tue, 12 Feb 2008 02:32:28 +0100 Subject: document otr commands --- doc/user-guide/commands.xml | 149 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 149 insertions(+) (limited to 'doc/user-guide') diff --git a/doc/user-guide/commands.xml b/doc/user-guide/commands.xml index 5a1e398c..4f4e44b3 100644 --- a/doc/user-guide/commands.xml +++ b/doc/user-guide/commands.xml @@ -243,6 +243,155 @@ + + + Off-the-Record encryption control + otr <subcommand> [<arguments>] + + + + + Available subcommands: connect, disconnect, smp, trust, info, keygen, and forget. See help otr <subcommand> for more information. + + + + + + otr connect <nick> + + + + + Attempts to establish an encrypted connection with the specified user by sending a magic string. + + + + + + + + otr disconnect <nick> + + + + + Resets the connection with the specified user to cleartext. + + + + + + + + otr smp <nick> <secret> + + + + + Attempts to authenticate the given user's active fingerprint via the Socialist Millionaires' Protocol. + + + + 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. + + + + + + + + otr trust <nick> <fp1> <fp2> <fp3> <fp4> <fp5> + + + + + Manually affirms trust in the specified fingerprint, given as five blocks of precisely eight (hexadecimal) digits each. + + + + + + + + otr info + otr info <nick> + + + + + 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. + + + + + + + + otr keygen <account-no> + + + + + Generates a new OTR private key for the given account. + + + + + + + + otr forget <thing> <arguments> + + + + + Forgets some part of our OTR userstate. Available things: fingerprint, context, and key. See help otr forget <thing> for more information. + + + + + + otr forget fingerprint <nick> <fingerprint> + + + + + 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. + + + + + + + + otr forget context <nick> + + + + + 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. + + + + + + + + otr forget key <fingerprint> + + + + + Forgets an OTR private key matching the specified fingerprint. It is allowed to specify only a (unique) prefix of the fingerprint. + + + + + + + + + Miscellaneous settings -- cgit v1.2.3