gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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


From: durner
Subject: [GNUnet-SVN] r922 - GNUnet-docs/WWW/test
Date: Mon, 13 Jun 2005 13:46:41 -0700 (PDT)

Author: durner
Date: 2005-06-13 13:46:36 -0700 (Mon, 13 Jun 2005)
New Revision: 922

Modified:
   GNUnet-docs/WWW/test/philosophy.php3
   GNUnet-docs/WWW/test/user.php3
   GNUnet-docs/WWW/test/user_chat.php3
   GNUnet-docs/WWW/test/user_gnunet.php3
   GNUnet-docs/WWW/test/user_testbed.php3
Log:
Format documentation I

Modified: GNUnet-docs/WWW/test/philosophy.php3
===================================================================
--- GNUnet-docs/WWW/test/philosophy.php3        2005-06-13 20:32:35 UTC (rev 
921)
+++ GNUnet-docs/WWW/test/philosophy.php3        2005-06-13 20:46:36 UTC (rev 
922)
@@ -11,6 +11,7 @@
 
 ANCHOR("copyright");
 H3("Copyright and Contributions");
+BP();
 W("GNUnet is part of the %s.",
   extlink_("http://www.gnu.org/","GNU project"));
 W("All code contributions must thus be put under the %s.",
@@ -20,25 +21,28 @@
 W("GNU standards and the %s should be adhered to.",
   extlink_("http://www.gnu.org/philosophy/philosophy.html","GNU philosophy"));
 
-BR();
+EP();
 
 ANCHOR("goals");
 H3("Design Goals and Philosophy");
 
+BP();
 W("The foremost goal of the GNUnet project is to become a widely used, 
reliable, open, nondiscriminating, egalitarian, unfettered and 
censorship-resistant system of free information exchange.");
 W("We value free speech above state secrets, law-enforcement or intellectual 
property.");
 W("GNUnet is supposed to be an anarchistic network, where the only limitation 
for peers is that they must contribute enough back to the network such that 
their resource consumption does not have a significant impact on other users.");
-P();
+EP();
 
 ANCHOR("Privacy");
 H4("Privacy");
+BP();
 W("GNUnet’s primary design goals are to protect the privacy of its users 
and to guard itself against attacks or abuse.");
 W("GNUnet does not have any mechanisms to control, track or censor users.");
 W("Instead, the GNUnet protocols aim to make it as hard as possible to find 
out what is happening on the network or to disrupt operations.");
-P();
+EP();
 
 ANCHOR("Versatility");
 H4("Versatility");
+BP();
 W("We call GNUnet a network because we want to support many different forms of 
peer-to-peer applications.");
 W("GNUnet uses a plugin architecture to make the system extensible and to 
encourage code reuse.");
 W("While the first versions of the system only supported anonymous 
file-sharing, other applications are being worked on and more will hopefully 
follow in the future.");
@@ -46,21 +50,23 @@
 W("The reason is that link encryption hides the specifics of the traffic for 
non-participating observers.");
 W("This way, anonymity can get stronger with additional (GNUnet) traffic, even 
if the additional traffic is not related to anonymous communication.");
 W("Increasing anonymity is the primary reason why GNUnet is developed to 
become a peer-to-peer framework.");
-P();
+EP();
 
 
 ANCHOR("Practicality");
 H4("Pracicality");
 
+BP();
 W("GNUnet allows participants to trade various amounts of security in exchange 
for increased efficiency.");
 W("However, it is not possible for any user's security and efficiency 
requirements to compromise the security and efficiency of any other user.");
 
+P();
 W("For GNUnet, efficiency is not paramount.");
 W("If there is a more secure and still practical approach, we would choose to 
take the more secure alternative.");
 W("<tt>telnet</tt> is more efficient than <tt>ssh</tt>, yet it is obsolete.");
 W("Hardware gets faster, and code can be optimized.");
 W("Fixing security issues as an afterthought is much harder.");
-BR();
+P();
 W("While security is paramount, practicability is still a requirement.");
 W("The most secure system is always the one that nobody can use.");
 W("Similarly, any anonymous system that is extremely inefficient will only 
find few users.");
@@ -71,32 +77,35 @@
 W("Many designs (e.g. anonymity via broadcast) fail to give users an incentive 
to choose a less secure but more efficient mode of operation.");
 W("GNUnet should avoid whereever possible to rely on protocols that will only 
work if the participants are benevolent.");
 W("While some designs have had widespread success while relying on parties to 
observe a protocol that may be sub-optimal for the individuals (e.g.  TCP 
Nagle), a protocol that ensures that individual goals never conflict with the 
goals of the group is always preferable.");
-P();
+EP();
 
 ANCHOR("concepts");
 H3("Concepts");
 
+BP();
 W("In this section, the fundamental concepts of GNUnet are explained.");
 W("Most of them are also described in our research papers.");
 W("First, some of the concepts used in the GNUnet framework are detailed.");
 W("The second part describes concepts specific to anonymous file-sharing.");
+EP();
 
 gnunetlogo();
 H4("Authentication");
 
+BP();
 W("Almost all peer-to-peer communications in GNUnet are between mutually 
authenticated peers.");
 W("The authentication works by having each peer sign a secret session key with 
its RSA key.");
 W("Furthermore, the session key is encrypted with the public key of the other 
peer.");
 W("That session key is then used to encrypt the communication between the two 
peers using Blowfish.");
 W("As only the two participating hosts know the session key, this 
authenticates each packet without requiring signatures each time.");
 
-BR();
+P();
 W("In GNUnet, the identity of a host is the hash of its public key.");
 W("For that reason, man-in-the-middle attacks will not break the 
authentication or accounting goals.");
 W("Essentially, for GNUnet, the IP of the host does not matter.");
 W("As the public key is the only thing that truly matters, faking an IP, a 
port or any other property of the underlying transport protocol is 
irrelevant.");
 
-BR();
+P();
 
 W("GNUnet uses a special type of message to communicate a binding between 
public (RSA) keys to their current network address.");
 W("For the UDP and TCP transport layers, a network address is an IP and a 
port.");
@@ -104,14 +113,15 @@
 W("Note that any node can have multiple addresses at the same time for the 
various transport mechanisms.");
 W("Binding messages expire after at most a week (the timeout can be shorter if 
the user configures the node appropriately).");
 
-P();
+EP();
 H4("Accounting to Encourage Resource Sharing");
 
+BP();
 W("Most distributed P2P networks suffer from a lack of defenses or precautions 
against attacks in the form of freeloading.");
 W("While the intentions of an attacker and a freeloader are different, their 
effect on the network is the same; they both render it useless.");
 W("Most simple attacks on networks such as Gnutella involve flooding the 
network with traffic, particularly with queries that are, in the worst case, 
multiplied by the network.");
 
-BR();
+P();
 
 W("In order to ensure that freeloaders or attackers have a minimal impact on 
the network, GNUnet tries to distinguish good (contributing) nodes from 
malicious (freeloading) nodes.");
 W("In GNUnet, every node keeps track of the behavior of every other node it 
has been in contact with.");
@@ -126,9 +136,10 @@
 W("More details can be found in %s.",
   extlink_("download/ebe.ps", "this paper"));
 
-P();
+EP();
 H4("Confidentiality");
 
+BP();
 W("Adversaries outside of GNUnet are not supposed to know what kind of actions 
a peer is involved in.");
 W("Only the specific neighbor of a peer that is the corresponding sender or 
recipient of a message may know its contents, and even then application 
protocols may place further restrictions on that knowledge.");
 W("In order to ensure confidentiality, GNUnet uses link encryption, that is 
each message exchanged between two peers is encrypted using a key only known to 
these two peers.");
@@ -139,11 +150,12 @@
         extlink_("#anonymity", "anonymity")));
 
 
-P();
+EP();
 afslogo();
 ANCHOR("anonymity");
 H4("Anonymity");
 
+BP();
 W("Providing anonymity for users is the central goal for the anonymous 
file-sharing application.");
 W("Many other design decisions follow in the footsteps of this requirement.");
 //W("(Nevertheless, it is possible to forego anonymity when this is not 
required.)");
@@ -157,7 +169,7 @@
 W("In particular, we assume that the adversary can see all the traffic on the 
Internet.");
 W("And while we assume that the adversary can not break our encryption, we 
assume that the adversary has many participating nodes in the network and that 
it can thus see many of the node-to-node interactions since it controls some of 
the nodes.");
 
-BR();
+P();
 
 W("The system tries to achieve anonymity based on the idea that users can be 
anonymous if they can hide their actions in the traffic created by other 
users.");
 W("Hiding actions in the traffic of other users requires participating in the 
traffic, bringing back the traditional technique of using indirection and 
source rewriting.");
@@ -173,21 +185,22 @@
 W("This increases the efficiency of the network as we can indirect less under 
higher load.");
 
 
-P();
+EP();
 ANCHOR("deniability");
 H4("Deniability");
 
+BP();
 W("Even if the user that downloads data and the server that provides data are 
anonymous, the intermediaries may still be targets.");
 W("In particular, if the intermediaries can find out which queries or which 
content they are processing, a strong adversary could try to force them to 
censor certain materials.");
 
-BR();
+P();
 
 W("With the file-encoding used by GNUnet's anonymous file-sharing, this 
problem does not arise.");
 W("The reason is that queries and replies are transmitted in an encrypted 
format such that intermediaries cannot tell what the query is for or what the 
content is about.");
 W("Mind that this is not the same encryption as the link-encryption between 
the nodes.");
 W("GNUnet has encryption on the network layer (link encryption, 
confidentiality, authentication) and again on the application layer (provided 
by <tt>gnunet-insert</tt>, <tt>gnunet-download</tt>, <tt>gnunet-search</tt> and 
<tt>gnunet-gtk</tt>).");
+EP();
 
 
-
 include("html_footer.php3");
 ?>

Modified: GNUnet-docs/WWW/test/user.php3
===================================================================
--- GNUnet-docs/WWW/test/user.php3      2005-06-13 20:32:35 UTC (rev 921)
+++ GNUnet-docs/WWW/test/user.php3      2005-06-13 20:46:36 UTC (rev 922)
@@ -5,6 +5,7 @@
 include("html_header.php3");
 
 H2("End-User Documentation");
+BP();
 W("GNUnet is a framework for peer-to-peer networking.");
 W("This means that based on a common codebase, GNUnet will be able to run a 
diverse set of applications.");
 W("The only useful application at the moment is %s.",
@@ -15,6 +16,7 @@
 P();
 
 W("The following pages describe first how to compile and configure GNUnet and 
then detail how to configure and use applications built with GNUnet.");
+EP();
 
 include("user_index.inc");
 

Modified: GNUnet-docs/WWW/test/user_chat.php3
===================================================================
--- GNUnet-docs/WWW/test/user_chat.php3 2005-06-13 20:32:35 UTC (rev 921)
+++ GNUnet-docs/WWW/test/user_chat.php3 2005-06-13 20:46:36 UTC (rev 922)
@@ -5,10 +5,11 @@
 include("html_header.php3");
 
 H2("gnunet-chat");
+BP();
 W("A rudimentary chat client has been implemented as reference code for how to 
implement other applications on top of the GNUnet peer-to-peer 
infrastructure.");
 W("At this point, it merely broadcasts messages to all other chat clients.");
 W("It is not really in any useable state.");
 
-P();
+EP();
 include("html_footer.php3");
 ?>

Modified: GNUnet-docs/WWW/test/user_gnunet.php3
===================================================================
--- GNUnet-docs/WWW/test/user_gnunet.php3       2005-06-13 20:32:35 UTC (rev 
921)
+++ GNUnet-docs/WWW/test/user_gnunet.php3       2005-06-13 20:46:36 UTC (rev 
922)
@@ -19,28 +19,36 @@
 <?php
 ANCHOR("installation");
 H3("Installation");
+BP();
 W("First, in addition to the %s you must download the latest version of %s and 
install that library.",
   ARRAY(intlink_("download.php3", "GNUnet sources"),
        extlink_("/libextractor/", "libextractor")));
 W("Libextractor requires glib (also required for GNUnet) and zlib (compression 
library, highly likely that you already have it).");
 W("Installing libextractor should be as simple as:");
+EP();
 PRE("# ./configure --prefix=\$HOME\n" .
     "# make\n" .
     "# make install\n");
+BP();
 W("For GNUnet, you should install gtk+ and either mysql or sqlite.");
 W("Now compile and install GNUnet using:");
+EP();
 PRE("# ./configure --prefix=\$HOME --with-extractor=\$HOME\n" .
     "# make\n" .
     "# make install\n");
-P();
+BP();
 W("Now test the installation using");
+EP();
 PRE("# gnunet-transport-check\n");
+BP();
 W("As a side-effect, this will generate the configuration file 
<tt>/etc/gnunet.conf</tt>.");
 W("If the test fails, you should edit the file to configure your network.");
 W("If you are using the mysql database, edit the configuration from the 
default (sqlite) to mysql.");
 W("After changing the configuration, you should always run 
<tt>gnunet-update</tt> to allow GNUnet to perform necessary internal updates.");
 W("Once configuration is complete and <tt>gnunet-update</tt> is done, start 
the server using:");
+EP();
 PRE("# gnunetd -d\n");
+BP();
 W("The &quot;-d&quot; option causes <tt>gnunetd</tt> to print all errors to 
the console and prevents <tt>gnunetd</tt> from detaching from the console.");
 W("If you get no error messages, press &quot;CTRL-C&quot; to abort 
<tt>gnunetd</tt> and restart it without the &quot;-d&quot; option.");
 W("Without the option, <tt>gnunetd</tt> will detach from the terminal and 
write errors into the logfile.");
@@ -67,15 +75,15 @@
 W("If you want to automatically start GNUnet each time your machine boots 
<tt>contrib/initgnunet</tt> contains an example script to start the server as 
user <em>gnunet</em> with a configuation in <tt>/etc/gnunet.conf</tt>.");
 W("If you installed a binary package, the installer probably already put the 
start-script into &quot;/etc/init.d/gnunetd&quot; or the appropriate location 
for your system.");
 W("Still, even in that case, you may have to activate the script.");
-P();
+EP();
 
 HR();
 
-P();
 ANCHOR("files");
 H3("The GNUnet configuration files");
 ANCHOR("gnunet.conf");
 
+BP();
 W("When a required configuration file is not present on startup, any GNUnet 
tool will attempt to create one by dumping a copy of the respective default 
configuration file to that location.");
 W("The option <tt>-c</tt> can be used for any GNUnet tool to specify an 
alternative location for the configuration file.");
 W("GNUnet uses two different configuration files (with the same syntax but 
different options), one for the server (<tt>gnunetd</tt>) and another one for 
all of the clients.");
@@ -89,10 +97,11 @@
 W("If the configuration file is not found, all GNUnet tools will use the 
default configuration file and write that configuration to the location where 
the configuration file was expected.");
 W("So you can always revert to the default configuration file by deleting or 
renaming the existing file.");
 
-BR();
+EP();
 
 ANCHOR("serveroptions"); H3("Server options");
 
+BP();
 W("All of the options described here refer to the server configuration.");
 W("This section describes the most important options to setup 
<tt>gnunetd</tt>.");
 W("If you are on dialup, look at %s and probably %s.",
@@ -107,10 +116,11 @@
 P();
 W("The configuration of the SMTP transport layer is described %s",
   intlink_("smtp.php3","here"));
-P();
+EP();
 
 ANCHOR("gnunet.conf.port");H4("NETWORK: PORT");
 
+BP();
 W("With this option, you can specify to which TCP port the gnunet-clients 
should connect.");
 W("It is also the choice of the port for <tt>gnunetd</tt>.");
 W("While you can restrict access to this port using the %s option, you may 
also want to firewall this port.",
@@ -118,18 +128,20 @@
 W("A different port must be used for the TCP and UDP peer-to-peer transport 
mechanism.");
 W("The default value is <tt>2087</tt>.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.interface");H4("NETWORK: INTERFACE");
 
+BP();
 W("Use this option to specify which interface GNUnet should use to try to 
determine your IP.");
 W("The interface is also used to determine the network load.");
 W("Alternatively, you can use the %s option.",
   extlink_("#gnunet.conf.ip", "IP"));
 W("If both an interface and an IP is specified, the IP option takes 
preference.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.ip");H4("NETWORK: IP");
 
+BP();
 W("This option allows you to specify the advertised IP.");
 W("If you do not specify anything, GNUnet will attempt to detect the IP.");
 W("You really need this option if you are behind a NAT box.");
@@ -137,33 +149,37 @@
 W("For NAT boxes with changing IP, you may want to use %s.",
   extlink_("http://www.technopagan.org/dynamic/";, "Dynamic DNS"));
 
-P();
+EP();
 ANCHOR("gnunet.conf.heloexchange");H4("NETWORK: HELOEXCHANGE");
 
+BP();
 W("If you set this option to <tt>NO</tt> your node will not forward HELO 
messages that advertise other nodes.");
 W("This option only makes sense if your node bridges two networks that both 
contain GNUnet nodes but that can not contact each other directly.");
 W("The default value is <tt>YES</tt>.");
 W("Stick to the default if you are unsure.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.trusted");H4("NETWORK: TRUSTED");
 
+BP();
 W("With this option you can specfiy which addresses are trusted enough to 
connect to gnunetd via TCP as clients.");
 W("The default is only the local host.");
 W("If you are on a trusted LAN, you may want to specify the LAN network and 
netmask.");
 W("You must use IPs, DNS lookup is not supported.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.interfaces");H4("LOAD: INTERFACES");
 
+BP();
 W("Under this option you specify which interfaces GNUnet is going to monitor 
to determine the load.");
 W("If you have ethernet, the default is <tt>eth0</tt>.");
 W("If you have a modem, try <tt>ppp0</tt>.");
 W("In general, the command <tt>ifconfig</tt> (may not be in your path if you 
are logged in as a normal user, try <tt>/sbin/ifconfig</tt>) will show you the 
active devices.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.basiclimiting");H4("LOAD: BASICLIMITING");
 
+BP();
 W("Use basic bandwidth limitation?");
 W("YES or NO.");
 W("The basic method notes only gnunet traffic and can be used to specify 
simple maximum bandwidth usage of GNUnet.");
@@ -171,21 +187,23 @@
 connection.");
 W("The basic method might also be good when the used interface can transmit 
data to/from local network very fast compared to internet traffic (a condition 
that makes the advanced method unreliable).");
 
-BR();
+P();
 
 W("The advanced bandwidth limitation measures total traffic over the chosen 
interface (including GNUnet traffic), and allows gnunetd to participate if the 
total traffic is low enough.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.maxnetbpsuptotal");H4("LOAD: MAXNETBPSUPTOTAL");
 
+BP();
 W("If you use basic bandwidth limitation, this option specifies the maximum 
GNUnet can use for its internal traffic.");
 W("When using advanced limiting, use this option to specify your maximum 
upload speed (how many bytes per second your node can send).");
 W("In that case, do not specify how much you want GNUnet to use, but use the 
maximum theoretically available.");
 W("If you do not know your bandwidth, stick with the default of 50.000 
bytes.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.maxnetbpsdowntotal");H4("LOAD: MAXNETBPSDOWNTOTAL");
 
+BP();
 W("Same as %s but for download speeds.",
   extlink_("#gnunet.conf.maxnetbpsuptotal", "MAXNETBPSUPTOTAL"));
 W("Note that GNUnet can not control exactly how much data other nodes are 
sending to your machine (an approximate control is attempted, but malicious 
peers can always ignore the protocol and send more data).");
@@ -193,9 +211,10 @@
 W("If we are above our boundaries for the download limits, GNUnet will notify 
peers to reduce the amount of traffic until we are back inside the limits.");
 W("Note that if you disable BASICLIMITING, GNUnet will sense if non-GNUnet 
traffic is going on and only use the specified amount of bandwidth if you are 
not using it otherwise.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.maxcpuload");H4("LOAD: MAXCPULOAD");
 
+BP();
 W("Up to which CPU load will GNUnet process packets from other nodes.");
 W("If the average CPU load goes over this value (like for the network, this 
includes other applications), GNUnet will start dropping packets and reduce the 
load.");
 W("GNUnet may also do fewer of the expensive message-packing computations, 
trading bandwidth for CPU time.");
@@ -203,9 +222,10 @@
 W("Only if the load is under the value specified here, GNUnet will serve other 
nodes.");
 W("The default is 50, which should keep your hosts responsive enough while 
being more than sufficient for GNUnet on any modern machine.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.udp.port");H4("UDP: PORT");
 
+BP();
 W("Which port should the UDP transport layer use?");
 W("If no value is specified, GNUnet will try to find a port in 
<tt>/etc/services</tt>.");
 W("If you specify 0, this means that you do not want to open UDP for receiving 
messages (but, if you load the transport module, you can still send UDP 
traffic).");
@@ -214,17 +234,19 @@
 W("Since other peers will try to connect to this port, you should configure 
your firewall to let all traffic through.");
 W("UDP is a stateless protocol, thus just allowing <tt>related</tt> traffic in 
a stateful firewall will not be sufficient.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.blacklist");H4("UDP: BLACKLIST");
 
+BP();
 W("If your node receives advertisements for nodes on virtual private networks, 
it should not even attempt to connect to those networks.");
 W("You can use this option to specify a list of networks that are forbidden.");
 W("gnunetd will then never attempt to communicate with these addresses.");
 W("You will get an error if your own IP address is listed here.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.udp.mtu");H4("UDP: MTU");
 
+BP();
 W("This option specifies the maximum transfer unit, the maximum number of 
bytes that GNUnet will put in a UDP packet.");
 W("This does not include the IP or UDP headers.");
 W("Do not use more than your OS (and firewall) can support.");
@@ -232,10 +254,11 @@
 W("You can determine your MTU using the <tt>ifconfig</tt> command.");
 W("For ethernet, the network MTU should be 1500 octets, resulting in 1472 
octets for the GNUnet MTU, which is also the default.");
 W("Do not use values smaller than 1200.");
-P();
+EP();
 
 ANCHOR("gnunet.conf.tcp.port");H4("TCP: PORT");
 
+BP();
 W("Which port should the TCP transport layer use?");
 W("If no value is specified, GNUnet will try to find a port in 
<tt>/etc/services</tt>.");
 W("If you specify 0, this means that you do not want to open TCP for receiving 
messages (but, if you load the transport module, you can still initiate 
bi-directional TCP connections).");
@@ -245,7 +268,7 @@
 W("Since other peers will try to connect to this port, you should configure 
your firewall to let all traffic through.");
 W("Make sure that the port number you select here does not conflict with the 
client TCP port.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.blacklist");H4("TCP: BLACKLIST");
 
 W("If your node receives advertisements for nodes on virtual private networks, 
it should not even attempt to connect to those networks.");
@@ -253,7 +276,7 @@
 W("gnunetd will then never attempt to communicate with these addresses.");
 W("You will get an error if your own IP address is listed here.");
 
-P();
+BP();
 ANCHOR("gnunet.conf.tcp.mtu");H4("TCP: MTU");
 
 W("This option specifies the maximum transfer unit, the maximum number of 
bytes that GNUnet will put in a TCP packet.");
@@ -262,65 +285,73 @@
 W("For ethernet, this would result in 1460 octets, which is also the 
default.");
 W("Do not use less than 1200.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.nat.limited"); H4("NAT: LIMITED");
+
+BP();
 W("The NAT transport allows connections between machines using network-address 
translation (NAT) and &quot;normal&quot; peers with a globally unique IP 
address.");
 W("Thus in practice, all GNUnet peers that support TCP should also load the 
NAT transport service, either since they need it to connect themselves or 
because it allows them to connect to other peers that require NAT support.");
 W("NAT support requires loading ethe TCP transport service (IPv4 and/or 
IPv6).");
 W("The only option for the NAT transport is &quot;LIMITED&quot;.");
 W("The default value &quot;NO&quot; is used for peers that 
<strong>either</strong> have a globally routed IP address (are not using NAT at 
all) <strong>or</strong> for peers that advertise the IP of the NAT box and 
where the NAT box forwards the TCP port to the NAT-ed IP in the LAN.");
 W("Only if you can not configure your NAT box to forward the TCP port to your 
local machine you should set LIMITED to &quot;YES&quot;.");
-BR();
+P();
 W("In summary, there are three possibilities.");
 W("If you use TCP and don&prime;t use NAT on your local network, load the NAT 
transport anyway, set LIMITED to &quot;NO&quot;.");
 W("If you use NAT on your local network and have control over your NAT box, 
configure the NAT box to forward the TCP (and if possibly UDP) ports to the 
machine running <tt>gnunetd</tt>, also load the NAT transport and also set 
LIMITED to &quot;NO&quot;.");
 W("If you use NAT on your local network and do NOT have control over the NAT 
box, you <strong>must</strong> load the TCP and the NAT transport, set the 
TCP-PORT to &quot;0&quot; and LIMITED to &quot;YES&quot;.");
-BR();
+P();
 W("The last option is the worst since it limits whom you can connect to and 
thus limits your anonymity.");
 W("If you are adventurous, you can supplement the last option with the SMTP 
transport, which is difficult to configure but will allow NAT-to-NAT 
communication.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.heloexpires");H4("GNUNETD: HELOEXPIRES");
-
+BP();
 W("This option specifies how long (in minutes) your node will claim to be 
reachable under the current IP.");
 W("If you have a permanent IP, a couple of days can be a reasonable value.");
 W("If you are on dialup, you may want to choose only an hour.");
 W("The default is 1440 (1 day).");
 W("The largest acceptable value is 14400 (10 days).");
 
-P();
+EP();
 ANCHOR("gnunet.conf.loglevel");H4("GNUNETD: LOGLEVEL");
 
+BP();
 W("Loglevel, how much should be logged?");
 W("You can use NOTHING, FATAL, ERROR, FAILURE, WARNING, MESSAGE INFO, DEBUG, 
CRON or EVERYTHING (which log more and more messages in this order).");
 W("Default is WARNING.");
 W("You can override this option at the commandline with the <tt>-L</tt> 
switch.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.logfile");H4("GNUNETD: LOGFILE");
 
+BP();
 W("If <tt>gnunetd</tt> is not started with the <tt>-d</tt> option, it writes 
logging messages into this file (with <tt>-d</tt> all messages are written to 
the console).");
 W(" Read this %s if you are using logrotate.",
   
extlink_("http://mail.gnu.org/archive/html/help-gnunet/2002-08/msg00012.html";, 
"mail"));
 
-P();
+EP();
 ANCHOR("gnunet.conf.pidfile");H4("GNUNETD: PIDFILE");
 
+BP();
 W("In which file should gnunetd write the process-id of the server?");
 W("If you run gnunetd as root, you may want to choose /var/run/gnunetd.pid.");
 W("It&rsquo;s not the default since gnunetd may not have write rights at that 
location.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.hosts");H4("GNUNETD: HOSTS");
 
+BP();
 W("In this directory GNUnet stores the key and last known Internet address of 
each known GNUnet node.");
 W("Each file is about 550 bytes long (different transport protocols may have 
different address sizes).");
 W("A %s of GNUnet hosts can be obtained from the GNUnet webpage.",
  extlink_("download/hosts.tar.gz", "list"));
 W("On startup, GNUnet downloads a list of initial hosts from 
<tt>http://ovmj.org/GNUnet/download/hostlist</tt>.");
 W("This list is generated using");
+EP();
 PRE("# cat ~/.gnunet/data/hosts/* > hostlist");
 
+BP();
 W("Alternative hostlist servers can be used by modifying 
<tt>gnunet.conf</tt>.");
 
 P();
@@ -330,15 +361,17 @@
 W("If hosts cannot be reached and the time that the key has been signed to be 
valid by the sender has expired, GNUnet deletes their identities from 
<tt>data/hosts/</tt>.");
 W("Note that the trust information is kept &quot;forever&quot;.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.hostlisturl");H4("GNUNETD: HOSTLISTURL");
 
+BP();
 W("Whenever gnunetd needs to learn about an initial set of peers that it can 
connect to, it downloads a list of initial nodes to connect to via http.");
 W("The URL to use is specified here.");
 
-P();
+EP();
 ANCHOR("gnunet.conf.applications");H4("GNUNETD: APPLICATIONS");
 
+BP();
 W("Which applications should gnunetd support?");
 W("Specify the name of the dynamic shared object (DSO) that implements the 
service in the gnunetd core here.");
 W("Multiple DSOs can be specified, separated by spaces.");
@@ -348,9 +381,10 @@
 W("Possible choices are &quot;%s chat tbench tracekit&quot;.",
   intlink_("user_afs.php3","fs"));
 
-P();
+EP();
 ANCHOR("gnunet.conf.transports");H4("GNUNETD: TRANSPORTS");
 
+BP();
 W("Which transport services should be used?");
 W("Use space-separated list of the modules, for example  &quot;udp smtp 
tcp&quot;.");
 W("If you want to use SMTP, please read the %s for details.",
@@ -360,6 +394,7 @@
 W("The <tt>contrib/</tt> directory contains a %s for the configuration that 
should be self-explanatory.",
   extlink_("gnunet.conf","template"));
 
+EP();
 HR();
 
 ANCHOR("clientoptions"); H3("Client options");
@@ -367,21 +402,23 @@
 ANCHOR("gnunet.conf.host");
 H4("NETWORK: HOST");
 
+BP();
 W("With this option, you can specify to which host the GNUnet clients should 
connect by default.");
 W("You can override the choice you make here with the <tt>-H</tt> option.");
 W("The default, <tt>localhost</tt> should be fine.");
 
-P();
+EP();
 
 ANCHOR("gnunet.conf.port");H4("NETWORK: PORT");
 
+BP();
 W("With this option, you can specify to which TCP port the gnunet-clients 
should connect.");
 W("It is also the choice of the port for <tt>gnunetd</tt>.");
 W("While you can restrict access to this port using the %s option, you may 
also want to firewall this port.",
   extlink_("#gnunet.conf.trusted", "NETWORK: TRUSTED"));
 W("A different port must be used for the TCP and UDP peer-to-peer transport 
mechanism.");
 W("The default value is <tt>2087</tt>.");
-P();
+EP();
 
 HR();
 
@@ -391,6 +428,7 @@
 ANCHOR("transportcheck");
 H4("gnunet-transport-check");
 
+BP();
 W("The <tt>gnunet-transport-check</tt> tool checks if a transport is 
configured correctly.");
 W("By default the tool checks if the transport is at least able to send a 
message to its own address.");
 W("This test is called the <em>loopback mode</em>.");
@@ -407,28 +445,29 @@
 W("Note that you can not run <tt>gnunet-transport-check</tt> while 
<tt>gnunetd</tt> is running!");
 W("You must stop <tt>gnunetd</tt> before testing transports.");
 W("The output of <tt>gnunet-transport-check</tt> looks something like this:");
-P();
+EP();
 
 PRE("$ gnunet-transport-check\n" .
     "Testing transport(s) udp tcp\n" .
     "Transport OK, 0ms for 1 messages of size 11 bytes.\n" .
     "Transport OK, 0ms for 1 messages of size 11 bytes.\n");
 
+BP();
 W("And for ping mode:");
+EP();
 
 PRE("$ gnunet-transport-check -p\n" .
     "Available transport(s): udp tcp\n" .
     ".....................\n" .
     "8 out of 21 peers contacted successfully (0 times transport 
unavailable).\n");
 
-P();
-
 ANCHOR("peerinfo");
 H4("gnunet-peer-info");
 
+BP();
 W("The <tt>gnunet-peer-info</tt> tool displays the internet addresses and the 
identities of all GNUnet peers that the local peer is aware of.");
 W("The output looks like this:");
-P();
+EP();
 
 PRE("$ gnunet-peer-info\n" .
     "F149393582FDEF31BB745ACD7AE21D9B65CFAC09 at address 121.49.31.144:2086 
(TCP)\n" .
@@ -445,17 +484,15 @@
     "42F91CAB229B3119F80A0D447A12FE867B60895F at address 23.99.191.24:2086 
(TCP)\n" .
     "8E846CAA7B75C1F88D3ADF94FCC89D6C8C95E1FF at address 85.42.211.167:2086 
(TCP)\n");
 
-P();
-
-
 ANCHOR("stats");H4("gnunet-stats");
 
+BP();
 W("<tt>gnunet-stats</tt> is a little tool that displays statistics.");
 W("Unlike the other core tools, it uses the client configuration and only 
works if <tt>gnunetd</tt> is already running.");
 W("<tt>gnunet-stats</tt> also only works if the <tt>stats</tt> module is 
loaded as an application.");
 W("The numbers are for the current gnunetd process only.");
 W("The output looks similar to the following example, but depends on which 
modules you have loaded and what your node has been doing so far.");
-P();
+EP();
 
 PRE("$ gnunet-stats\n" .
     "Uptime (seconds)                                            :             
  47\n" .
@@ -485,9 +522,10 @@
     "# HELO messages forwarded from other peers                  :             
   0\n" .
     "# HELO messages originated                                  :             
   0\n");
 
+BP();
 W("The number of connected hosts is the nummber of hosts that the local node 
is directly connected to (1 hop).");
 W("The total number of hosts in the network must be larger or equal to this 
number.");
-P();
+EP();
 
 include("html_footer.php3");
 ?>

Modified: GNUnet-docs/WWW/test/user_testbed.php3
===================================================================
--- GNUnet-docs/WWW/test/user_testbed.php3      2005-06-13 20:32:35 UTC (rev 
921)
+++ GNUnet-docs/WWW/test/user_testbed.php3      2005-06-13 20:46:36 UTC (rev 
922)
@@ -6,13 +6,15 @@
 
 H2("Deploying a GNUnet P2P testbed");
 
+BP();
 W("A P2P testbed is an environment in which P2P developers can test new 
ideas.");
 W("Ordinary users can help developers by making their machines available for 
testing.");
 W("This document describes how users can setup their machines to participate 
in a testbed (and details the risks involved) and how developers can use the 
testing infrastructure.");
 
-P();
+EP();
 H3("Setting up a testbed client");
 
+BP();
 W("Since setting up a testbed client is quite trivial, the most difficult step 
is to decide if it is a good idea.");
 W("The benefits of providing a client to developers are obvious, the 
developers may be able to develop and test their free software faster.");
 W("On the other hand, the risks are plentiful.");
@@ -41,9 +43,10 @@
 W("Note that that system could also be advertising an SSH key.");
 W("If there is no web-based registration system, you may want to contact the 
developers directly with your IP and port (you may have changed the 2086 
default).");
 
-P();
+EP();
 H3("Setting up a testbed meta-server");
 
+BP();
 W("The purpose of a testbed meta-server is to maintain a list of available 
peers for running tests.");
 W("A meta-server is typically a WWW server which is contacted by peers that 
register and unregister their service.");
 W("The <tt>contrib/</tt> directory contains a few PHP scripts that can be used 
to setup a meta-server that uses an MySQL database to store the list of 
available peers.");
@@ -65,6 +68,7 @@
 W("The results of the testbed commands (standard output and return values, to 
be precise), can be processed with other bash commands in the usual way.");
 W("For documentation on BASH itself, see <tt>man bash</tt>.");
 W("The complete list of testbed specific commands is changing frequently and 
should be documented in the <tt>gnunet-testbed</tt> man page.");
+EP();
 
 include("html_footer.php3");
 ?>





reply via email to

[Prev in Thread] Current Thread [Next in Thread]