kytv/I2P_Website
1
0
Fork 0
forked from I2P_Developers/i2p.www
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Tag BOB spec in docs/api/bob for highlighting

Browse Source
This commit is contained in:
str4d
2013-06-10 12:33:09 +00:00
parent 315f00d1e4
commit 51affabc20
1 changed files with 25 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
i2p2www/pages/site/docs/api/bob.html
View File

@@ -70,7 +70,7 @@ Commands never get obsoleted or changed, however new commands do get added from
Here are the commands we have as of this writing: Here are the commands we have as of this writing:
{%- endtrans %}</p> {%- endtrans %}</p>
<pre> {% highlight %}
{{ _('COMMAND') }} {{ _('OPERAND') }} {{ _('RETURNS') }} {{ _('COMMAND') }} {{ _('OPERAND') }} {{ _('RETURNS') }}
help (optional command to get help on) NOTHING or OK and description of the command help (optional command to get help on) NOTHING or OK and description of the command
clear ERROR or OK clear ERROR or OK
@@ -96,7 +96,7 @@ stop ERROR or OK
verify KEY ERROR or OK verify KEY ERROR or OK
visit OK, and dumps BOB's threads to the wrapper.log visit OK, and dumps BOB's threads to the wrapper.log
zap nothing, quits BOB zap nothing, quits BOB
</pre> {% endhighlight %}
<p>{% trans -%} <p>{% trans -%}
Once set up, all TCP sockets can and will block as needed, and there is no need for any Once set up, all TCP sockets can and will block as needed, and there is no need for any
@@ -124,7 +124,7 @@ the INET superserver daemon. Destination "ear" will be a local port that you
can telnet into, and watch the pretty ASCII test puke forth. can telnet into, and watch the pretty ASCII test puke forth.
{%- endtrans %}</p> {%- endtrans %}</p>
<pre> {% highlight %}
{% trans %}EXAMPLE SESSION DIALOGUE -- simple telnet 127.0.0.1 2827 works{% endtrans %} {% trans %}EXAMPLE SESSION DIALOGUE -- simple telnet 127.0.0.1 2827 works{% endtrans %}
A = {{ _('Application') }} A = {{ _('Application') }}
C = {% trans %}BOB's Command response.{% endtrans %} C = {% trans %}BOB's Command response.{% endtrans %}
@@ -134,13 +134,13 @@ A C setnick mouth
C A OK Nickname set to mouth C A OK Nickname set to mouth
A C newkeys A C newkeys
C A OK ZMPz1zinTdy3~zGD~f3g9aikZTipujEvvXOEyYfq4Su-mNKerqG710hFbkR6P-xkouVyNQsqWLI8c6ngnkSwGdUfM7hGccqBYDjIubTrlr~0g2-l0vM7Y8nSqtFrSdMw~pyufXZ0Ys3NqUSb8NuZXpiH2lCCkFG21QPRVfKBGwvvyDVU~hPVfBHuR8vkd5x0teMXGGmiTzdB96DuNRWayM0y8vkP-1KJiPFxKjOXULjuXhLmINIOYn39bQprq~dAtNALoBgd-waZedYgFLvwHDCc9Gui8Cpp41EihlYGNW0cu0vhNFUN79N4DEpO7AtJyrSu5ZjFTAGjLw~lOvhyO2NwQ4RiC4UCKSuM70Fz0BFKTJquIjUNkQ8pBPBYvJRRlRG9HjAcSqAMckC3pvKKlcTJJBAE8GqexV7rdCCIsnasJXle-6DoWrDkY1s1KNbEVH6i1iUEtmFr2IHTpPeFCyWfZ581CAFNRbbUs-MmnZu1tXAYF7I2-oXTH2hXoxCGAAAA C A OK ZMPz1zinTdy3~zGD~f3g9aikZTipujEvvXOEyYfq4Su-mNKerqG710hFbkR6P-xkouVyNQsqWLI8c6ngnkSwGdUfM7hGccqBYDjIubTrlr~0g2-l0vM7Y8nSqtFrSdMw~pyufXZ0Ys3NqUSb8NuZXpiH2lCCkFG21QPRVfKBGwvvyDVU~hPVfBHuR8vkd5x0teMXGGmiTzdB96DuNRWayM0y8vkP-1KJiPFxKjOXULjuXhLmINIOYn39bQprq~dAtNALoBgd-waZedYgFLvwHDCc9Gui8Cpp41EihlYGNW0cu0vhNFUN79N4DEpO7AtJyrSu5ZjFTAGjLw~lOvhyO2NwQ4RiC4UCKSuM70Fz0BFKTJquIjUNkQ8pBPBYvJRRlRG9HjAcSqAMckC3pvKKlcTJJBAE8GqexV7rdCCIsnasJXle-6DoWrDkY1s1KNbEVH6i1iUEtmFr2IHTpPeFCyWfZ581CAFNRbbUs-MmnZu1tXAYF7I2-oXTH2hXoxCGAAAA
</pre> {% endhighlight %}
<p><b>{% trans -%} <p><b>{% trans -%}
MAKE NOTE OF THE ABOVE DESTINATION KEY, YOURS WILL BE DIFFERENT! MAKE NOTE OF THE ABOVE DESTINATION KEY, YOURS WILL BE DIFFERENT!
{%- endtrans %}</b></p> {%- endtrans %}</b></p>
<pre> {% highlight %}
{{ _('FROM') }} {{ _('TO') }} {{ _('DIALOGUE') }} {{ _('FROM') }} {{ _('TO') }} {{ _('DIALOGUE') }}
A C outhost 127.0.0.1 A C outhost 127.0.0.1
C A OK outhost set C A OK outhost set
@@ -148,7 +148,7 @@ A C outport 19
C A OK outbound port set C A OK outbound port set
A C start A C start
C A OK tunnel starting C A OK tunnel starting
</pre> {% endhighlight %}
<p>{% trans -%} <p>{% trans -%}
At this point, there was no error, a destination with a nickname of "mouth" At this point, there was no error, a destination with a nickname of "mouth"
@@ -160,7 +160,7 @@ to the <code>CHARGEN</code> service on <code>19/TCP</code>.
Now for the other half, so that we can actually contact this destination. Now for the other half, so that we can actually contact this destination.
{%- endtrans %}</p> {%- endtrans %}</p>
<pre> {% highlight %}
{{ _('FROM') }} {{ _('TO') }} {{ _('DIALOGUE') }} {{ _('FROM') }} {{ _('TO') }} {{ _('DIALOGUE') }}
A C setnick ear A C setnick ear
C A OK Nickname set to ear C A OK Nickname set to ear
@@ -174,7 +174,7 @@ A C start
C A OK tunnel starting C A OK tunnel starting
A C quit A C quit
C A OK Bye! C A OK Bye!
</pre> {% endhighlight %}
<p>{% trans -%} <p>{% trans -%}
Now all we need to do is telnet into 127.0.0.1, port 37337, Now all we need to do is telnet into 127.0.0.1, port 37337,
@@ -187,8 +187,8 @@ key and it goes.
<b>NOTE:</b> The "quit" command in the command channel does NOT disconnect the tunnels like SAM. <b>NOTE:</b> The "quit" command in the command channel does NOT disconnect the tunnels like SAM.
{%- endtrans %}</p> {%- endtrans %}</p>
<pre> {% highlight lang='bash' %}
# telnet 127.0.0.1 37337 $ telnet 127.0.0.1 37337
Trying 127.0.0.1... Trying 127.0.0.1...
Connected to 127.0.0.1. Connected to 127.0.0.1.
Escape character is '^]'. Escape character is '^]'.
@@ -199,33 +199,33 @@ ZMPz1zinTdy3~zGD~f3g9aikZTipujEvvXOEyYfq4Su-mNKerqG710hFbkR6P-xkouVyNQsqWLI8c6ng
#$%&amp;'()*+,-./0123456789:;&lt;=&gt;?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghij #$%&amp;'()*+,-./0123456789:;&lt;=&gt;?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghij
$%&amp;'()*+,-./0123456789:;&lt;=&gt;?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijk $%&amp;'()*+,-./0123456789:;&lt;=&gt;?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijk
... ...
</pre> {% endhighlight %}
<p>{% trans -%} <p>{% trans -%}
After a few virtual miles of this spew, press <code>Control-]</code> After a few virtual miles of this spew, press <code>Control-]</code>
{%- endtrans %}</p> {%- endtrans %}</p>
<pre> {% highlight lang='bash' %}
... ...
cdefghijklmnopqrstuvwxyz{|}~ !"#$%&amp;'()*+,-./0123456789:;&lt;=&gt;?@ABCDEFGHIJK cdefghijklmnopqrstuvwxyz{|}~ !"#$%&amp;'()*+,-./0123456789:;&lt;=&gt;?@ABCDEFGHIJK
defghijklmnopqrstuvwxyz{|}~ !"#$%&amp;'()*+,-./0123456789:;&lt;=&gt;?@ABCDEFGHIJKL defghijklmnopqrstuvwxyz{|}~ !"#$%&amp;'()*+,-./0123456789:;&lt;=&gt;?@ABCDEFGHIJKL
efghijklmnopqrstuvwxyz{|}~ !"#$%&amp;'()*+,-./0123456789:;&lt;= efghijklmnopqrstuvwxyz{|}~ !"#$%&amp;'()*+,-./0123456789:;&lt;=
telnet&gt; c telnet&gt; c
Connection closed. Connection closed.
</pre> {% endhighlight %}
<p>{% trans -%} <p>{% trans -%}
Here is what happened... Here is what happened...
{%- endtrans %}</p> {%- endtrans %}</p>
<pre> {% highlight %}
telnet -&gt; ear -&gt; i2p -&gt; mouth -&gt; chargen -. telnet -&gt; ear -&gt; i2p -&gt; mouth -&gt; chargen -.
telnet &lt;- ear &lt;- i2p &lt;- mouth &lt;-----------' telnet &lt;- ear &lt;- i2p &lt;- mouth &lt;-----------'
</pre> {% endhighlight %}
<p>{% trans -%} <p>{% trans -%}
You can connect to EEPSITES too! You can connect to EEPSITES too!
{%- endtrans %}</p> {%- endtrans %}</p>
<pre> {% highlight lang='bash' %}
# telnet 127.0.0.1 37337 $ telnet 127.0.0.1 37337
Trying 127.0.0.1... Trying 127.0.0.1...
Connected to 127.0.0.1. Connected to 127.0.0.1.
Escape character is '^]'. Escape character is '^]'.
@@ -250,8 +250,8 @@ Accept-Ranges: bytes
&lt;img src="/counter.gif" alt="!@^7A76Z!#(*&amp;amp;%"&gt; visitors. &lt;/body&gt; &lt;img src="/counter.gif" alt="!@^7A76Z!#(*&amp;amp;%"&gt; visitors. &lt;/body&gt;
&lt;/html&gt; &lt;/html&gt;
Connection closed by foreign host. Connection closed by foreign host.
# $
</pre> {% endhighlight %}
<p>{% trans -%} <p>{% trans -%}
Pretty cool isn't it? Try some other well known EEPSITES if you like, nonexistent ones, Pretty cool isn't it? Try some other well known EEPSITES if you like, nonexistent ones,
@@ -268,19 +268,19 @@ Let's put down our destinations now that we are all done with them.
First, lets see what destination nicknames we have. First, lets see what destination nicknames we have.
{%- endtrans %}</p> {%- endtrans %}</p>
<pre> {% highlight %}
{{ _('FROM') }} {{ _('TO') }} {{ _('DIALOGUE') }} {{ _('FROM') }} {{ _('TO') }} {{ _('DIALOGUE') }}
A C list A C list
C A DATA NICKNAME: mouth STARTING: false RUNNING: true STOPPING: false KEYS: true QUIET: false INPORT: not_set INHOST: localhost OUTPORT: 19 OUTHOST: 127.0.0.1 C A DATA NICKNAME: mouth STARTING: false RUNNING: true STOPPING: false KEYS: true QUIET: false INPORT: not_set INHOST: localhost OUTPORT: 19 OUTHOST: 127.0.0.1
C A DATA NICKNAME: ear STARTING: false RUNNING: true STOPPING: false KEYS: true QUIET: false INPORT: 37337 INHOST: 127.0.0.1 OUTPORT: not_set OUTHOST: localhost C A DATA NICKNAME: ear STARTING: false RUNNING: true STOPPING: false KEYS: true QUIET: false INPORT: 37337 INHOST: 127.0.0.1 OUTPORT: not_set OUTHOST: localhost
C A OK Listing done C A OK Listing done
</pre> {% endhighlight %}
<p>{% trans -%} <p>{% trans -%}
Alright, there they are. First, let's remove "mouth". Alright, there they are. First, let's remove "mouth".
{%- endtrans %}</p> {%- endtrans %}</p>
<pre> {% highlight %}
{{ _('FROM') }} {{ _('TO') }} {{ _('DIALOGUE') }} {{ _('FROM') }} {{ _('TO') }} {{ _('DIALOGUE') }}
A C getnick mouth A C getnick mouth
C A OK Nickname set to mouth C A OK Nickname set to mouth
@@ -288,14 +288,14 @@ A C stop
C A OK tunnel stopping C A OK tunnel stopping
A C clear A C clear
C A OK cleared C A OK cleared
</pre> {% endhighlight %}
<p>{% trans -%} <p>{% trans -%}
Now to remove "ear", note that this is what happens when you type too fast, Now to remove "ear", note that this is what happens when you type too fast,
and shows you what typical ERROR messages looks like. and shows you what typical ERROR messages looks like.
{%- endtrans %}</p> {%- endtrans %}</p>
<pre> {% highlight %}
{{ _('FROM') }} {{ _('TO') }} {{ _('DIALOGUE') }} {{ _('FROM') }} {{ _('TO') }} {{ _('DIALOGUE') }}
A C getnick ear A C getnick ear
C A OK Nickname set to ear C A OK Nickname set to ear
@@ -307,7 +307,7 @@ A C clear
C A OK cleared C A OK cleared
A C quit A C quit
C A OK Bye! C A OK Bye!
</pre> {% endhighlight %}
<p>{% trans -%} <p>{% trans -%}
I won't bother to show an example of the receiver end of a bridge I won't bother to show an example of the receiver end of a bridge