[Dcplusplus-commit] SF.net SVN: adc:[20] trunk/ADC-EXT.txt

[<ul...@us...>]

Revision: 20
          http://adc.svn.sourceforge.net/adc/?rev=20&view=rev
Author:   ullner
Date:     2010-07-12 12:58:20 +0000 (Mon, 12 Jul 2010)

Log Message:
-----------
Added autowidth to tables to so they text fit appropriately to columns.
Changed level 1 titles to real example use.

Modified Paths:
--------------
    trunk/ADC-EXT.txt

Modified: trunk/ADC-EXT.txt
===================================================================
--- trunk/ADC-EXT.txt	2010-07-12 12:19:09 UTC (rev 19)
+++ trunk/ADC-EXT.txt	2010-07-12 12:58:20 UTC (rev 20)
@@ -80,6 +80,7 @@
 
 In SCH and GFI, the following attributes are added:
 
+[options="autowidth"]
 |=====
 |TR |Tiger tree Hash root, encoded with base32.
 |TD |Tree depth, index of the highest level of tree data available, root-only = 0, first level (2 leaves) = 1, second level = 2, etc...
@@ -128,7 +129,7 @@
 normal INF along with the following added fields ( none mandatory, if not present,
 it means hub has no restrictions in that matter, or non existent):
 
-[options="header"]
+[options="header, autowidth"]
 |=====
 |Code | Type | Description
 |HH |string |Hub Host address ( DNS or IP )
@@ -160,14 +161,13 @@
 doesn't require additional information about the users).
 
 ===== Example
----- 
+==== 
  -pinger- HSUP ADBASE ADPING AD..
  -hub- ISUP ADBASE ADPING AD..
  -hub- ISID ..
  -hub- IINF NIhubname DEcurrent\stopic VE.. HHmyhub.no-ip.org:555 WShttp://myhub.no-ip.org/ OWmyname UC2231 SS.. SF.. MS0 ML0 MC5000
  - (pinger may disconnect)
- -..
-----
+==== 
 
 ==== Hub - Hublist communication
 
@@ -178,13 +178,13 @@
 name and WS hublist web address.
 
 ===== Example
-----
+==== 
  -hub- HSUP ADBASE ADPING AD..
  -hublist- ISUP ADBASE ADPING AD..
  -hublist- IINF NIhublist_name WShublist_address
  -hub- HINF  NIhubname DEcurrent\stopic VE.. HHmyhub.no-ip.org:555 WShttp://myhub.no-ip.org/ OWmyname UC2231 SS.. SF.. MS0 ML0 MC5000
  -( disconnect )
-----
+==== 
 
 === TS - Timestamp in MSG
 Timestamp of the moment when the message was sent, expressed in seconds since the Unix Epoch (January 1 1970 00:00:00 GMT).
@@ -206,6 +206,7 @@
 
 Response of a client. 
 
+[options="autowidth"]
 |=====
 |HA |Hub address 
 |LG |Last succesfull login time ( number of seconds since the epoch (1970), (UTC) ) 
@@ -225,6 +226,7 @@
 
 Name uniquely (per hub) identifies a particular user command. The name may contain "/" to indicate a logical structure on the viewing client, where each "/" introduces a new submenu level. Other than name, the command also has a number of flags that further detail what to do with it. 
 
+[options="autowidth"]
 |=====
 |RM |1 = Remove Command
 |CT |Message Category,  1 = Hub command, client parameters only, 2 = User list command, client and user parameters, 4 = Search result command, client, user and file parameters, 8 = File list command, client, user and file parameters. Multiple types are specified by adding the numbers together. 
@@ -239,6 +241,7 @@
 The following tables specify the keywords that must be supported. 
 
 Client parameters 
+[options="autowidth"]
 |=====
 |myCID |Client CID
 |mySID |ClientSID
@@ -246,6 +249,7 @@
 |=====
 
 User parameters
+[options="autowidth"]
 |=====
 |userCID |User CID
 |userSID |User SID
@@ -254,30 +258,37 @@
 |=====
 
 File parameters
+[options="autowidth"]
 |=====
 |fileXX |One for each flag contained within a search result or file list entry (see RES)
 |fileMN |Specify magnet link. http://en.wikipedia.org/wiki/Magnet_link[Magnet links] are used to reference files across networks and applications. Clients may ignore parameters it does not understand, but are free to pass on the parameters to other programs.
 |=====
 
 Hub parameters
+[options="autowidth"]
 |=====
 |hubXX |One for each flag of the hub; for example, hubNI and hubVE
 |=====
 
 ==== Example
-|=====
-|ICMD ADCH++/Hub\smanagement/Register\snick TTHMSG\s+regnick\s%[userNI]\s%[line:Password\s(leave\sempty\sto\sun-reg)]\s%[line:Level\s(facultative;\sdefaults\sto\syour\sown\slevel\sminus\sone)]\n CT2
-|ICMD ADCH++/Hub\smanagement/Reload\sbans TTHMSG\s+loadbans\n CT3
-|ICMD ADCH++/Hub\smanagement/Reload\sscripts TTHMSG\s+reload\n CT3
-|ICMD ADCH++/Info TTHMSG\s+info\s%[userNI]\n CT2
-|ICMD ADCH++/Info TTHMSG\s+info\n CT1
-|=====
+==== 
+ICMD ADCH++/Hub\smanagement/Register\snick TTHMSG\s+regnick\s%[userNI]\s%[line:Password\s(leave\sempty\sto\sun-reg)]\s%[line:Level\s(facultative;\sdefaults\sto\syour\sown\slevel\sminus\sone)]\n CT2
 
+ICMD ADCH++/Hub\smanagement/Reload\sbans TTHMSG\s+loadbans\n CT3
+
+ICMD ADCH++/Hub\smanagement/Reload\sscripts TTHMSG\s+reload\n CT3
+
+ICMD ADCH++/Info TTHMSG\s+info\s%[userNI]\n CT2
+
+ICMD ADCH++/Info TTHMSG\s+info\n CT1
+==== 
+
 === BLOM- Bloom filter
 
 Bloom filters allow the hub to filter certain searches using bitmap that represents the hashes of the files in the users share. BLOM is an extension that allows hub software to create a map (bloom filter) of the shared files on the hub, but with minimal effort, e.g. the hub doesn't keep a list of files, but a filter that never produces false negatives but only possible false positives. This can potentially save bandwidth and effort on the client side. When the user updates the share, the client must send an INF containing the flag SF. The hub may at any time request that the client sends an updated version of its bloom filter by sending a GET command to the client. The client will then respond using SND and send the bloom filter binary data. 
 
 ==== Legend
+[options="autowidth"]
 |=====
 |b |Number of bits used for file hashes
 |n |Number of files in the user's share
@@ -290,6 +301,7 @@
 The hub chooses k, h and m.
 
 ==== Restrictions
+[options="autowidth"]
 |=====
 |k * h < = b
 |h < = 64
@@ -298,6 +310,7 @@
 |=====
 
 ==== Probability
+[options="autowidth"]
 |=====
 |p == (1 - (1 - 1 / m)^(k * n)^)^k^ |False positives
 |p == 0 |False negatives
@@ -319,6 +332,7 @@
 For the GET type, m / 8 shall be used as byte amount. 
 
 Updates GET with the following flags; 
+[options="autowidth"]
 |=====
 |BK |Specify 'k'.
 |BH |Specify 'h'.
@@ -369,12 +383,16 @@
 ==== Example
 Client A is connected to hub A with the outbound port 1000 and client B is connected to hub A with the outbound port 2000. Client A has the SID AAAA and client B has the SID BBBB.
 
-----
+==== 
 Client A: DRCM AAAA BBBB ADC/1.0 foobar
+
 Client B: DNAT BBBB AAAA ADC/1.0 2000 foobar
+
 <Client A connects to client B's IP address and port 2000>
+
 Client A: DRNT AAAA BBBB ADC/1.0 1000 foobar
+
 <Client B connects  to client A's IP address and port 1000>
-----
+==== 
 
 // vim: set syntax=asciidoc:


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.