BOB doc fixes (ticket #1839)

This commit is contained in:
zzz
2016-08-19 18:51:47 +00:00
parent 12f42555e0
commit bc67408294

View File

@@ -1,6 +1,6 @@
{% extends "global/layout.html" %}
{% block title %}{{ _('BOB - Basic Open Bridge') }}{% endblock %}
{% block lastupdated %}{% trans %}November 2015{% endtrans %}{% endblock %}
{% block lastupdated %}{% trans %}August 2016{% endtrans %}{% endblock %}
{% block content %}
<h2>Language libraries for the BOB API</h2>
<ul>
@@ -39,6 +39,8 @@ SAM router stores every keypair you ever make.
Those are the important differences.
{%- endtrans %}</p>
<h2>{% trans %}Overview{% endtrans %}</h2>
<p>{% trans -%}
<code>KEYS</code> = keypair public+private, these are BASE64
{%- endtrans %}</p>
@@ -61,6 +63,46 @@ the rules... it can actually return nothing! This is intentional, since
help is a HUMAN and not an APPLICATION command.
{%- endtrans %}</p>
<h2>{% trans %}Connection and Version{% endtrans %}</h2>
<p>{% trans -%}
All BOB status output is by lines. Lines may be \n or \r\n terminated, depending on the system.
On connection, BOB outputs two lines:
{%- endtrans %}</p>
{% highlight lang='text' %}
BOB version
OK
{% endhighlight %}
<p>{% trans -%}
The current version is:
{%- endtrans %} 00.00.10</p>
<p>{% trans -%}
Note that previous versions used upper-case hex digits and did not conform to I2P versioning standards.
It is recommended that subsequent versions use digits 0-9 only.
{%- endtrans %} 00.00.10</p>
<p>{% trans -%}
Version history
{%- endtrans %}</p>
<table>
<tr><th>{% trans %}Version{% endtrans %}</th>
<th>{% trans %}I2P Router Version{% endtrans %}</th>
<th>{% trans %}Changes{% endtrans %}</th></tr>
<tr><td>00.00.10</td>
<td>0.9.8</td>
<td>{% trans %}current version{% endtrans %}</td></tr>
<tr><td>00.00.00 - 00.00.0F</td>
<td>&nbsp;</td>
<td>{% trans %}development versions{% endtrans %}</td></tr>
</table>
<h2>{% trans %}Commands{% endtrans %}</h2>
<p>{% trans -%}
<b>PLEASE NOTE:</b>
For CURRENT details on the commands PLEASE use the built-in help command.
@@ -71,10 +113,6 @@ Just telnet to localhost 2827 and type help and you can get full documentation o
Commands never get obsoleted or changed, however new commands do get added from time to time.
{%- endtrans %}</p>
<p>{% trans -%}
Here are the commands we have as of this writing:
{%- endtrans %}</p>
{% highlight lang='text' %}
{{ _('COMMAND') }} {{ _('OPERAND') }} {{ _('RETURNS') }}
help (optional command to get help on) NOTHING or OK and description of the command
@@ -123,6 +161,8 @@ when bringing the bridge up, the normal TCP application won't care, and won't no
It will simply be fooled -- the destinations are not reachable, and that nothing is coming in.
{%- endtrans %}</p>
<h2>{% trans %}Examples{% endtrans %}</h2>
<p>{% trans -%}
For the following example, we'll setup a very simple local loopback connection,
with two destinations. Destination "mouth" will be the CHARGEN service from
@@ -136,6 +176,8 @@ A = {{ _('Application') }}
C = {% trans %}BOB's Command response.{% endtrans %}
{{ _('FROM') }} {{ _('TO') }} {{ _('DIALOGUE') }}
C A BOB 00.00.10
C A OK
A C setnick mouth
C A OK Nickname set to mouth
A C newkeys
@@ -168,6 +210,8 @@ Now for the other half, so that we can actually contact this destination.
{% highlight lang='text' %}
{{ _('FROM') }} {{ _('TO') }} {{ _('DIALOGUE') }}
C A BOB 00.00.10
C A OK
A C setnick ear
C A OK Nickname set to ear
A C newkeys