regenerated documentation. added makefile for docs, added rst template file

2008-10-17 03:23:30 +00:00
parent 18017c3f72
commit 81bf8763f6
13 changed files with 1338 additions and 861 deletions
--- a/docs/udp_tracker_protocol.html
+++ b/docs/udp_tracker_protocol.html
@@ -6,52 +6,74 @@
 <meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
 <title>Bittorrent udp-tracker protocol extension</title>
 <meta name="author" content="Arvid Norberg, arvid&#64;rasterbar.com" />
+<link rel="stylesheet" type="text/css" href="../../css/base.css" />
+<link rel="stylesheet" type="text/css" href="../../css/rst.css" />
 <link rel="stylesheet" href="style.css" type="text/css" />
+<style type="text/css">
+/* Hides from IE-mac \*/
+* html pre { height: 1%; }
+/* End hide from IE-mac */
+</style>
 </head>
 <body>
 <div class="document" id="bittorrent-udp-tracker-protocol-extension">
+    <div id="container">
+    <div id="headerNav">
+    <ul>
+    <li class="first"><a href="/">Home</a></li>
+    <li><a href="../../products.html">Products</a></li>
+    <li><a href="../../contact.html">Contact</a></li>
+    </ul>
+    </div>
+    <div id="header">
+    <h1><span>Rasterbar Software</span></h1>
+    <h2><span>Software developement and consulting</span></h2>
+    <span>
+    </span>
+    </div>
+    <div id="main">
 <h1 class="title">Bittorrent udp-tracker protocol extension</h1>
 <table class="docinfo" frame="void" rules="none">
 <col class="docinfo-name" />
 <col class="docinfo-content" />
 <tbody valign="top">
 <tr><th class="docinfo-name">Author:</th>
-<td>Arvid Norberg, <a class="last reference" href="mailto:arvid&#64;rasterbar.com">arvid&#64;rasterbar.com</a></td></tr>
+<td>Arvid Norberg, <a class="last reference external" href="mailto:arvid&#64;rasterbar.com">arvid&#64;rasterbar.com</a></td></tr>
 </tbody>
 </table>
 <div class="contents topic" id="table-of-contents">
-<p class="topic-title first"><a name="table-of-contents">Table of contents</a></p>
+<p class="topic-title first">Table of contents</p>
 <ul class="simple">
-<li><a class="reference" href="#introduction" id="id2" name="id2">introduction</a></li>
-<li><a class="reference" href="#connecting" id="id3" name="id3">connecting</a></li>
-<li><a class="reference" href="#announcing" id="id4" name="id4">announcing</a></li>
-<li><a class="reference" href="#scraping" id="id5" name="id5">scraping</a></li>
-<li><a class="reference" href="#errors" id="id6" name="id6">errors</a></li>
-<li><a class="reference" href="#actions" id="id7" name="id7">actions</a></li>
-<li><a class="reference" href="#extensions" id="id8" name="id8">extensions</a><ul>
-<li><a class="reference" href="#authentication" id="id9" name="id9">authentication</a></li>
+<li><a class="reference internal" href="#introduction" id="id2">introduction</a></li>
+<li><a class="reference internal" href="#connecting" id="id3">connecting</a></li>
+<li><a class="reference internal" href="#announcing" id="id4">announcing</a></li>
+<li><a class="reference internal" href="#scraping" id="id5">scraping</a></li>
+<li><a class="reference internal" href="#errors" id="id6">errors</a></li>
+<li><a class="reference internal" href="#actions" id="id7">actions</a></li>
+<li><a class="reference internal" href="#extensions" id="id8">extensions</a><ul>
+<li><a class="reference internal" href="#authentication" id="id9">authentication</a></li>
 </ul>
 </li>
-<li><a class="reference" href="#credits" id="id10" name="id10">credits</a></li>
+<li><a class="reference internal" href="#credits" id="id10">credits</a></li>
 </ul>
 </div>
-<div class="section">
-<h1><a id="introduction" name="introduction">introduction</a></h1>
+<div class="section" id="introduction">
+<h1>introduction</h1>
 <p>A tracker with the protocol &quot;udp://&quot; in its URI
 is supposed to be contacted using this protocol.</p>
 <p>This protocol is supported by
-<a class="reference" href="http://xbtt.sourceforge.net">xbt-tracker</a>.</p>
+<a class="reference external" href="http://xbtt.sourceforge.net">xbt-tracker</a>.</p>
 <p>For additional information and descritptions of
 the terminology used in this document, see
-the <a class="reference" href="http://wiki.theory.org/index.php/BitTorrentSpecification">protocol specification</a></p>
+the <a class="reference external" href="http://wiki.theory.org/index.php/BitTorrentSpecification">protocol specification</a></p>
 <p>All values are sent in network byte order (big endian). The sizes
 are specified with ANSI-C standard types.</p>
 <p>If no response to a request is received within 15 seconds, resend
 the request. If no reply has been received after 60 seconds, stop
 retrying.</p>
 </div>
-<div class="section">
-<h1><a id="connecting" name="connecting">connecting</a></h1>
+<div class="section" id="connecting">
+<h1>connecting</h1>
 <p>Client sends packet:</p>
 <table border="1" class="docutils">
 <colgroup>
@@ -100,7 +122,7 @@ identify the protocol.</td>
 <td>action</td>
 <td>Describes the type of packet, in this
 case it should be 0, for connect.
-If 3 (for error) see <a class="reference" href="#errors">errors</a>.</td>
+If 3 (for error) see <a class="reference internal" href="#errors">errors</a>.</td>
 </tr>
 <tr><td>int32_t</td>
 <td>transaction_id</td>
@@ -120,8 +142,8 @@ anymore.</td>
 </tbody>
 </table>
 </div>
-<div class="section">
-<h1><a id="announcing" name="announcing">announcing</a></h1>
+<div class="section" id="announcing">
+<h1>announcing</h1>
 <p>Client sends packet:</p>
 <table border="1" class="docutils">
 <colgroup>
@@ -144,7 +166,7 @@ establishing the connection.</td>
 <tr><td>int32_t</td>
 <td>action</td>
 <td>Action. in this case, 1 for announce.
-See <a class="reference" href="#actions">actions</a>.</td>
+See <a class="reference internal" href="#actions">actions</a>.</td>
 </tr>
 <tr><td>int32_t</td>
 <td>transaction_id</td>
@@ -209,7 +231,7 @@ in the reply. Use -1 for default.</td>
 </tr>
 <tr><td>uint16_t</td>
 <td>extensions</td>
-<td>See <a class="reference" href="#extensions">extensions</a></td>
+<td>See <a class="reference internal" href="#extensions">extensions</a></td>
 </tr>
 </tbody>
 </table>
@@ -231,8 +253,8 @@ in the reply. Use -1 for default.</td>
 <td>action</td>
 <td>The action this is a reply to. Should
 in this case be 1 for announce.
-If 3 (for error) see <a class="reference" href="#errors">errors</a>.
-See <a class="reference" href="#actions">actions</a>.</td>
+If 3 (for error) see <a class="reference internal" href="#errors">errors</a>.
+See <a class="reference internal" href="#actions">actions</a>.</td>
 </tr>
 <tr><td>int32_t</td>
 <td>transaction_id</td>
@@ -282,8 +304,8 @@ seeding.</td>
 </tbody>
 </table>
 </div>
-<div class="section">
-<h1><a id="scraping" name="scraping">scraping</a></h1>
+<div class="section" id="scraping">
+<h1>scraping</h1>
 <p>Client sends packet:</p>
 <table border="1" class="docutils">
 <colgroup>
@@ -306,7 +328,7 @@ establishing of the connection.</td>
 <tr><td>int32_t</td>
 <td>action</td>
 <td>The action, in this case, 2 for
-scrape. See <a class="reference" href="#actions">actions</a>.</td>
+scrape. See <a class="reference internal" href="#actions">actions</a>.</td>
 </tr>
 <tr><td>int32_t</td>
 <td>transaction_id</td>
@@ -353,7 +375,7 @@ the MTU.</p>
 <td>action</td>
 <td>The action, should in this case be
 2 for scrape.
-If 3 (for error) see <a class="reference" href="#errors">errors</a>.</td>
+If 3 (for error) see <a class="reference internal" href="#errors">errors</a>.</td>
 </tr>
 <tr><td>int32_t</td>
 <td>transaction_id</td>
@@ -393,8 +415,8 @@ leechers.</td>
 </tbody>
 </table>
 </div>
-<div class="section">
-<h1><a id="errors" name="errors">errors</a></h1>
+<div class="section" id="errors">
+<h1>errors</h1>
 <p>In case of a tracker error,</p>
 <p>server replies packet:</p>
 <table border="1" class="docutils">
@@ -413,7 +435,7 @@ leechers.</td>
 <tr><td>int32_t</td>
 <td>action</td>
 <td>The action, in this case 3, for error.
-See <a class="reference" href="#actions">actions</a>.</td>
+See <a class="reference internal" href="#actions">actions</a>.</td>
 </tr>
 <tr><td>int32_t</td>
 <td>transaction_id</td>
@@ -428,8 +450,8 @@ describing the error.</td>
 </tbody>
 </table>
 </div>
-<div class="section">
-<h1><a id="actions" name="actions">actions</a></h1>
+<div class="section" id="actions">
+<h1>actions</h1>
 <p>The action fields has the following encoding:</p>
 <blockquote>
 <ul class="simple">
@@ -440,17 +462,17 @@ describing the error.</td>
 </ul>
 </blockquote>
 </div>
-<div class="section">
-<h1><a id="extensions" name="extensions">extensions</a></h1>
+<div class="section" id="extensions">
+<h1>extensions</h1>
 <p>The extensions field is a bitmask. The following
 bits are assigned:</p>
 <blockquote>
 <ul class="simple">
-<li>1 = <a class="reference" href="#authentication">authentication</a>.</li>
+<li>1 = <a class="reference internal" href="#authentication">authentication</a>.</li>
 </ul>
 </blockquote>
-<div class="section">
-<h2><a id="authentication" name="authentication">authentication</a></h2>
+<div class="section" id="authentication">
+<h2>authentication</h2>
 <p>The packet will have an authentication part
 appended to it. It has the following format:</p>
 <table border="1" class="docutils">
@@ -489,10 +511,21 @@ from the 20 bytes hash calculated.</td>
 </table>
 </div>
 </div>
-<div class="section">
-<h1><a id="credits" name="credits">credits</a></h1>
+<div class="section" id="credits">
+<h1>credits</h1>
 <p>Protocol designed by Olaf van der Spek</p>
 </div>
+    </div>
+    <div id="footer">
+    <span>Copyright &copy; 2005 Rasterbar Software.</span>
+    </div>
+    </div>
+    <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
+    </script>
+    <script type="text/javascript">
+    _uacct = "UA-1599045-1";
+    urchinTracker();
+    </script>
 </div>
 </body>
 </html>