Changeset f5ac0fb


Ignore:
Timestamp:
2008-02-12T01:32:28Z (12 years ago)
Author:
Sven Moritz Hallberg <sm@…>
Branches:
master
Children:
1c18ce1
Parents:
3ffc53e
Message:

document otr commands

File:
1 edited

Legend:

Unmodified
Added
Removed
  • doc/user-guide/commands.xml

    r3ffc53e rf5ac0fb  
    244244                </description>
    245245        </bitlbee-command>
     246       
     247        <bitlbee-command name="otr">
     248                <short-description>Off-the-Record encryption control</short-description>
     249                <syntax>otr &lt;subcommand&gt; [&lt;arguments&gt;]</syntax>
     250
     251                <description>
     252
     253                        <para>
     254                                Available subcommands: connect, disconnect, smp, trust, info, keygen, and forget. See <emphasis>help otr &lt;subcommand&gt;</emphasis> for more information.
     255                        </para>
     256
     257                </description>
     258               
     259                <bitlbee-command name="connect">
     260                        <syntax>otr connect &lt;nick&gt;</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 &lt;nick&gt;</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 &lt;nick&gt; &lt;secret&gt;</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 &lt;nick&gt; &lt;fp1&gt; &lt;fp2&gt; &lt;fp3&gt; &lt;fp4&gt; &lt;fp5&gt;</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 &lt;nick&gt;</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 &lt;account-no&gt;</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 &lt;thing&gt; &lt;arguments&gt;</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 &lt;thing&gt;</emphasis> for more information.
     349                                </para>
     350                       
     351                        </description>
     352                       
     353                        <bitlbee-command name="fingerprint">
     354                                <syntax>otr forget fingerprint &lt;nick&gt; &lt;fingerprint&gt;</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 &lt;nick&gt;</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 &lt;fingerprint&gt;</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>
    246395
    247396        <bitlbee-command name="set">
Note: See TracChangeset for help on using the changeset viewer.