[GNUnet-SVN] r938 - GNUnet-docs/WWW/test

[durner]

Author: durner
Date: 2005-06-14 12:23:52 -0700 (Tue, 14 Jun 2005)
New Revision: 938

Modified:
   GNUnet-docs/WWW/test/protocol_cs.php3
   GNUnet-docs/WWW/test/protocol_cs_afs.php3
   GNUnet-docs/WWW/test/protocol_cs_core.php3
   GNUnet-docs/WWW/test/protocol_cs_testbed.php3
Log:
Reformat

Modified: GNUnet-docs/WWW/test/protocol_cs.php3
===================================================================
--- GNUnet-docs/WWW/test/protocol_cs.php3       2005-06-14 19:14:14 UTC (rev 
937)
+++ GNUnet-docs/WWW/test/protocol_cs.php3       2005-06-14 19:23:52 UTC (rev 
938)
@@ -5,26 +5,28 @@
 include("html_header.php3");
 
 ANCHOR("CSprotocol");H3("GNUnet Protocol: client-to-node");
+BP();
 W("This section describes the protocol that is used on the 
<strong>trusted</strong>, reliable TCP connection between <tt>gnunetd</tt> and 
the clients (such as <tt>gnunet-insert</tt>, <tt>gnunet-search</tt>, 
<tt>gnunet-download</tt> or <tt>gnunet-gtk</tt>).");
 W("TCP is stream oriented, but GNUnet breaks the stream into records.");
 W("The different messages between GNUnet and the clients all have the 
following basic format:");
-echo "<table border=3>\n";
+EP();
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
 include("bittable.inc");
 row(shortEntry_("size of the record", NBO_()),
     shortEntry_("CS message type", NBO_()));
 rowIntEntry("(size - 4) bytes of data");
 echo "</table>\n";
-P();
+BP();
 W("The message type constants are defined in <tt>gnunet_protocols.h</tt> and 
all have names starting with <tt>CS_PROTO_</tt>.");
 W("The suffix <tt>REQUEST</tt> is used for messages from the client to 
<tt>gnunetd</tt>.");
 W("<tt>REPLY</tt> is used for messages from <tt>gnunetd</tt> to the client.");
 W("If <tt>gnunetd</tt> receives a REQUEST that it does not understand, it 
closes the connection (to prevent the client from blocking on a reply that may 
never come).");
-BR();
+P();
 W("See also %s.",
   extlink_("doxygen/html/tcpio_8c-source.html","tcpio.c"));
 
 W("The following groups of client-server messages are currently documented:");
-P();
+EP();
 include("protocol_cs_index.inc");
 include("html_footer.php3");
 ?>
\ No newline at end of file

Modified: GNUnet-docs/WWW/test/protocol_cs_afs.php3
===================================================================
--- GNUnet-docs/WWW/test/protocol_cs_afs.php3   2005-06-14 19:14:14 UTC (rev 
937)
+++ GNUnet-docs/WWW/test/protocol_cs_afs.php3   2005-06-14 19:23:52 UTC (rev 
938)
@@ -5,9 +5,10 @@
 include("html_header.php3");
 
 ANCHOR("CSprotocolAFS");H3("GNUnet Protocol: client-to-node: Anonymous File 
Sharing");
-P();
+BP();
 afslogo();
 W("The GNUnet client-to-node procotol currently defines the following 
messages:");
+EP();
 ?>
 <ul>
  <li><a href="#CS_QUERY">QUERY</a></li>
@@ -32,14 +33,15 @@
 </ul>
 <?php
 
-P();
 ANCHOR("CS_QUERY");H4("QUERY");
+BP();
 W("The client sends a message of this form whenever it is searching or 
downloading.");
 W("The server is expected to perform the search and send results back to the 
client.");
 W("The server can send any number of results with any delay (but typically no 
results are returned after ttl seconds and the client will re-issue the 
request), including none.");
 W("The format of the CS_QUERY message is:");
+EP();
 
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
 include("bittable.inc");
 rowSizeType("12+n*20", "8");
 rowIntEntryNBO("priority");
@@ -47,65 +49,69 @@
 fiveRowIntEntries("query [n]");
 echo "</table>\n";
 
-P();
 ANCHOR("CS_3HASH");H4("3HASH");
+BP();
 W("If <tt>gnunetd</tt> finds a search result to a %s, it sends back the data 
encapsulated in this message.",
   extlink_("#CS_QUERY","QUERY"));
 W("The message contains the double hash from the query to identify the 
result.");
 W("The format of the  message is:");
+EP();
 
-echo "<table border=3>";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">";
 include("bittable.inc");
 rowSizeType("1048","9");
 fiveRowIntEntries("proof (double hash)");
 rowIntEntry("data (1024 octets)");
 echo "</table>";
 
-P();
 ANCHOR("CS_CHK");H4("CHK");
+BP();
 W("If <tt>gnunetd</tt> finds a download result to a %s, it sends back the data 
encapsulated in this message.",
   extlink_("#CS_QUERY","QUERY"));
 W("The format of the message is:");
+EP();
 
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
 include("bittable.inc");
 rowSizeType("1028","10");
 rowIntEntry("data (1024 octets)");
 echo "</table>\n";
 
-P();
 ANCHOR("CS_INSERT_CHK");H4("INSERT_CHK");
+BP();
 W("Clients send this message to insert search results into the network.");
 W("The server is supposed to store the data and share it with other nodes.");
 W("Note that there are two ways to share data, via insertion and via %s.",
   extlink_("#CS_INDEX_BLOCK","indexing"));
 W("Indexing only applies to downloads and never to search results.");
 W("The importance in this message tells the server how important it is to 
store this content, so that the server can decide which content to discard if 
it is running out of space.");
-BR();
+P();
 W("If the insertion was successful, the server replies with a %s containing 
<tt>OK</tt>, otherwise the server replies with <tt>SYSERR</tt>.",
   extlink_("#CS_RETURN_VALUE","RETURN_VALUE"));
-BR();
+P();
 W("The format of the INSERT_CHK message is:");
+EP();
 
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
 include("bittable.inc");
 rowSizeType("1032","11");
 rowIntEntryNBO("priority");
 rowIntEntry("data (1024 octets)");
 echo "</table>\n";
 
-P();
 ANCHOR("CS_INSERT_3HASH");H4("INSERT_3HASH");
+BP();
 W("Clients send this message to insert search results into the network.");
 W("The server is supposed to store the data and share it with other nodes.");
 W("The importance in this message tells the server how important it is to 
store this content, so that the server can decide which content to discard if 
it is running out of space.");
-BR();
+P();
 W("If the insertion was successful, the server replies with a %s containing 
<tt>OK</tt>, otherwise the server replies with <tt>SYSERR</tt>.",
   extlink_("#CS_RETURN_VALUE","RETURN_VALUE"));
-BR();
+P();
 W("The format of the INSERT_3HASH message is:");
+EP();
 
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
 include("bittable.inc");
 rowSizeType("1052","12");
 rowIntEntryNBO("priority");
@@ -113,25 +119,26 @@
 rowIntEntry("data (1024 octets)");
 echo "</table>\n";
 
-P();
 ANCHOR("CS_INDEX_BLOCK");H4("INDEX_BLOCK");
+BP();
 W("Clients send this message to insert content into the network.");
 W("The indexing message does not contain the data but describes a way for the 
server to find on-demand.");
 W("The %s contains an index into the list of filenames and the offset in the 
file at which the block corresponding to the query can be found.",
   extlink_("doxygen/html/structContentIndex.html","ContentIndex struct"));
-BR();
+P();
 W("If the indexing was successful, the server replies with a %s containing 
<tt>OK</tt>, otherwise the server replies with <tt>SYSERR</tt>.",
   extlink_("#CS_RETURN_VALUE","RETURN_VALUE"));
 W("The format of the INDEX_BLOCK message is:");
+EP();
 
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
 include("bittable.inc");
 rowSizeType("36", "13");
 
rowIntEntryVerbatim(extlink_("doxygen/html/structContentIndex.html","ContentIndex")
 . W_("(32 octets)"));
 echo "</table>\n";
 
-P();
 ANCHOR("CS_INDEX_FILE");H4("INDEX_FILE");
+BP();
 W("This message is used by the client to add a file to the list of shared 
files.");
 W("<tt>gnunetd</tt> responds to this request with %s which can be used in the 
%s messages.",
   ARRAY(extlink_("#CS_RETURN_VALUE","an index into the list of files"),
@@ -142,77 +149,85 @@
 W("The server responds with a value of SYSERR if the quota-settings 
(INDEX-QUOTA) will not allow the upload of the file.");
 W("The client should use filesize 0 if a symlink will be used and thus the 
quota check can hence be avoided.");
 W("The format of the INDEX_FILE message is:");
+EP();
 
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
 include("bittable.inc");
 rowSizeType("32", "20");
 rowIntEntry("filesize");
 fiveRowIntEntries("Hash of the file (used to create the filename)");
 echo "</table>\n";
 
-P();
 ANCHOR("CS_INDEX_SUPER");H4("INDEX_SUPER");
+BP();
 W("This message adds a hash-code to one of the bloom filters, making the 
content effectively available.");
 W("The format of the INDEX_SUPER is:");
+EP();
 
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
 include("bittable.inc");
 rowSizeType("24", "15");
 fiveRowIntEntries("proof (super hash)");
 echo "</table>\n";
 
-P();
 ANCHOR("CS_DELETE_CHK");H4("DELETE_CHK");
+BP();
 W("The CS_DELETE_CHK message uses the same format as the %s message, only that 
the type is set to 16.",
   extlink_("#CS_INSERT_CHK","CS_INSERT_CHK"));
 W("The AFS module then deletes the corresponding CHK block.");
 W("A %s is send back to indicate success or failure.",
    extlink_("#CS_RETURN_VALUE","RETURN_VALUE"));
+EP();
 
-P();
 ANCHOR("CS_DELETE_3HASH");H4("DELETE_3HASH");
+BP();
 W("The CS_DELETE_3HASH message uses the same format as the %s message, only 
that the type is set to 17.",
   extlink_("#CS_INSERT_CHK","CS_INSERT_CHK"));
 W("The AFS module then deletes the corresponding block.");
 W("A %s is send back to indicate success or failure.",
    extlink_("#CS_RETURN_VALUE","RETURN_VALUE"));
 W("CS_DELETE_3HASH is not currently used by the code since there is no good 
way to establish the RBlocks that correspond to a given file when facing 
user-supplied keywords and meta-data.");
+EP();
 
-P();
 ANCHOR("CS_UNINDEX_BLOCK");H4("UNINDEX_BLOCK");
+BP();
 W("The CS_UNINDEX_BLOCK message uses the same format as the %s message, only 
that the type is set to 18.",
   extlink_("#CS_INDEX_BLOCK","CS_INDEX_BLOCK"));
 W("The AFS module then removes the corresponding index entry from the 
database.");
 W("A %s is send back to indicate success or failure.",
    extlink_("#CS_RETURN_VALUE","RETURN_VALUE"));
+EP();
 
-P();
 ANCHOR("CS_UNINDEX_FILE");H4("UNINDEX_FILE");
+BP();
 W("The CS_UNINDEX_BLOCK message uses the same format as the %s message, only 
that the type is set to 19.",
   extlink_("#CS_INDEX_FILE","CS_INDEX_FILE"));
 W("The AFS module then removes the corresponding file from the file list.");
 W("A %s is send back to indicate success or failure.",
    extlink_("#CS_RETURN_VALUE","RETURN_VALUE"));
+EP();
 
-P();
 ANCHOR("CS_UNINDEX_SUPER");H4("UNINDEX_SUPER");
+BP();
 W("The CS_UNINDEX_SUPER message uses the same format as the %s message, only 
that the type is set to 20.",
   extlink_("#CS_INDEX_FILE","CS_INDEX_FILE"));
 W("The AFS module then deletes the corresponding hash from the bloomfilter for 
super-hashes.");
 W("A %s is send back to indicate success or failure.",
    extlink_("#CS_RETURN_VALUE","RETURN_VALUE"));
+EP();
 
-P();
 ANCHOR("CS_NSQUERY");H4("NSQUERY");
+BP();
 W("This message is used by clients to initiate a namespace query.");
 W("It differs from ordinary queries in that it also contains the identifier of 
the namespace N.");
 W("Furthermore, an NSQUERY can only contain one identifier that is 
requested.");
 W("The SBlock identifier R that is used in an NSQUERY is derived from the 
namespace identifier N and the key K that is used to encrypt the corresponding 
SBlock by the following formula:");
-P();
+EP();
 PRE("R := H(K) XOR N");
-P();
+BP();
 W("The format is:");
-echo "<table border=3>\n";
+EP();
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
 include("bittable.inc");
 rowSizeType("52","21");
 rowIntEntryNBO("priority");
@@ -221,12 +236,13 @@
 fiveRowIntEntries("R (SBlock identifier)");
 echo "</table>\n";
 
-P();
 ANCHOR("CS_INSERT_SBLOCK");H4("INSERT_SBLOCK");
+BP)(;
 W("This message is used by clients to insert an SBlock into the network.");
 W("The format is:");
+EP();
 
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
 include("bittable.inc");
 rowSizeType("1032","22");
 rowIntEntryNBO("priority");
@@ -242,15 +258,18 @@
     shortEntry_("padding (must be 0)"));
 echo "</table>\n";
 
+BP();
 W("Note that there is currently no corresponding message to delete an 
SBlock.");
+EP();
 
-P();
 ANCHOR("CS_RESULT_SBLOCK");H4("RESULT_SBLOCK");
+BP();
 W("This message is send from the server to the client whenever a response to 
an %s is found.",
   extlink_("#CS_NSQUERY","NSQUERY"));
 W("The format is:");
+EP();
 
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
 include("bittable.inc");
 rowSizeType("1028","23");
 rowIntEntry("encrypted data (484 bytes)");
@@ -265,13 +284,14 @@
     shortEntry_("padding (must be 0)"));
 echo "</table>\n";
 
+BP();
 W("Note that there is currently no corresponding message to delete an 
SBlock.");
+EP();
 
 
-
-P();
 ANCHOR("CS_UPLOAD_FILE"); H4("UPLOAD_FILE");
 
+BP();
 W("This message is used by the client to upload (part of) a file being 
indexed.");
 W("The file is identified by its RIPE160MD hash.");
 W("Each upload message contains a variable number of bytes starting at a 
certain offset.");
@@ -279,7 +299,8 @@
 W("Note that the client still must send the indexing requests for the 
individual blocks.");
 W("<tt>gnunetd</tt> signals success or error with a RETURN_VALUE of OK or 
SYSERR.");
 W("The format of the message is:");
-echo "<table border=3>\n";
+EP();
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
 include("bittable.inc");
 rowSizeType("variable, &gt; 28", "24");
 rowIntEntry("position in the file");
@@ -288,14 +309,15 @@
 echo "</table>\n";
 
 
-P();
 ANCHOR("CS_LINK_FILE"); H4("LINK_FILE");
+BP();
 W("Instead of creating a copy, try to create a symbolic link.");
 W("The given filename is the target name.");
 W("<tt>gnunetd</tt> must verify that the file is accessible AND that the 
contents match the provided RIPE160MD hash.");
 W("<tt>gnunetd</tt> signals success or error with a RETURN_VALUE of OK or 
SYSERR.");
 W("The format of the message is:");
-echo "<table border=3>\n";
+EP();
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
 include("bittable.inc");
 rowSizeType("variable, &gt; 24", "25");
 fiveRowIntEntries("Hash code identifying the file");
@@ -303,13 +325,14 @@
 echo "</table>\n";
 
 
-P();
 ANCHOR("CS_GET_AVG_PRIORITY"); H4("GET_AVG_PRIORITY");
 
+BP();
 W("This query is used by the client to determine the current average priority 
of requests from OTHER peers that are in the routing table.");
 W("The server responds with a RETURN_VALUE message containing that average 
priority (or SYSERR on error).");
 W("The format of the message is:");
-echo "<table border=3>\n";
+EP();
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
 include("bittable.inc");
 rowSizeType("4", "26");
 echo "</table>\n";

Modified: GNUnet-docs/WWW/test/protocol_cs_core.php3
===================================================================
--- GNUnet-docs/WWW/test/protocol_cs_core.php3  2005-06-14 19:14:14 UTC (rev 
937)
+++ GNUnet-docs/WWW/test/protocol_cs_core.php3  2005-06-14 19:23:52 UTC (rev 
938)
@@ -128,7 +128,7 @@
 W("The format of the SHUTDOWN_REQUEST message is:");
 EP();
 
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
 include("bittable.inc");
 rowSizeType("4", "64");
 echo "</table>\n";

Modified: GNUnet-docs/WWW/test/protocol_cs_testbed.php3
===================================================================
--- GNUnet-docs/WWW/test/protocol_cs_testbed.php3       2005-06-14 19:14:14 UTC 
(rev 937)
+++ GNUnet-docs/WWW/test/protocol_cs_testbed.php3       2005-06-14 19:23:52 UTC 
(rev 938)
@@ -5,28 +5,33 @@
 include("html_header.php3");
 
 ANCHOR("CSprotocolTestbed");H3("GNUnet Protocol: client-to-node: testbed");
+BP();
 W("The testbed protocol encapsulates all of its messages within two global 
message types, <tt>CS_TESTBED_REQUEST</tt> and <tt>CS_TESTBED_REPLY</tt>.");
 W("Also note that the testbed module does not define peer-to-peer messages by 
itself.");
 W("The testbed protocol is used to instrument the peer-to-peer network, but 
does not use peer-to-peer protocols to achieve that.");
 W("The testbed setup itself is inherently client-server.");
-P();
+EP();
 
 ANCHOR("CS_TESTBED_REQUEST");H4("CS_TESTBED_REQUEST");
+BP();
 W("The CS_TESTBED_REQUEST message is used to request a specific action from 
the peer.");
 W("The action itself is specified in the <tt>message type</tt> field.");
 W("Depending on the message type, the testbed-request message is further 
parametrized by variable-size data.");
 W("Thus CS_TESTBED_REQUEST is inherently a variable-size message.");
 W("The general format of the CS_TESTBED_REQUEST message is:");
+EP();
 
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
 include("bittable.inc");
 rowSizeType("size","50");
 rowIntEntryNBO("message type");
 rowIntEntry("(size - 8) bytes of data");
 echo "</table>\n";
 
+BP();
 W("The possible parametrizations are (see also %s):",
   extlink_("doxygen/html/testbed_8h.html", "testbed.h"));
+EP();
 echo "<ul>";
 $messages = ARRAY(1=>"ADD_PEER",
                  2=>"DEL PEER",
@@ -58,22 +63,25 @@
 ANCHOR("LOAD_MODULE"); H5("LOAD_MODULE");
 ANCHOR("UNLOAD_MODULE"); H5("UNLOAD_MODULE");
 
-P();
 ANCHOR("CS_TESTBED_REPLY");H4("CS_TESTBED_REPLY");
+BP();
 W("The CS_TESTBED_REPLY message is used as a response from the peer to some of 
the CS_TESTBED_REQUEST messages.");
 W("Specifics of the response are encoded in the <tt>message type</tt> field.");
 W("Depending on the message type, the testbed-reply message is further 
parametrized by variable-size data.");
 W("Overall, CS_TESTBED_REPLY is very similar to CS_TESTBED_REQUEST, only that 
it is send in the other direction.");
 W("The general format of the CS_TESTBED_REPLY message is:");
+EP();
 
-echo "<table border=3>\n";
+echo "<table border=\"0\" cellspacing=\"0\" cellpadding=\"0\">\n";
 include("bittable.inc");
 rowSizeType("size","51");
 rowIntEntryNBO("message type");
 rowIntEntry("(size - 8) bytes of data");
 echo "</table>\n";
 
+BP();
 W("The possible parametrizations are:");
+EP();
 echo "<ul>";
 $messages = ARRAY(0=>"HELO_RESPONSE");
 foreach($messages as $i=>$b)
@@ -83,6 +91,5 @@
 
 ANCHOR("HELO_RESPONSE"); H5("TESTBED_HELO_RESPONSE");
 
-P();
 include("html_footer.php3");
 ?>
\ No newline at end of file