[GNUnet-SVN] r5419 - GNUnet-docs/WWW

[gnunet]

Author: grothoff
Date: 2007-08-06 16:42:32 -0600 (Mon, 06 Aug 2007)
New Revision: 5419

Modified:
   GNUnet-docs/WWW/user_afs.php3
   GNUnet-docs/WWW/user_gnunet.php3
Log:
some documentation updates

Modified: GNUnet-docs/WWW/user_afs.php3
===================================================================
--- GNUnet-docs/WWW/user_afs.php3       2007-08-06 21:26:59 UTC (rev 5418)
+++ GNUnet-docs/WWW/user_afs.php3       2007-08-06 22:42:32 UTC (rev 5419)
@@ -330,7 +330,7 @@
 BP();
 W("by executing ");
 EP();
-PRE("mysql> REPAIR TABLE data1024of?");
+PRE("mysql> REPAIR TABLE gnXXXX");
 BP();
 W("for each table in the gnunet database (USE gnunet; SHOW TABLES;)");
 EP();

Modified: GNUnet-docs/WWW/user_gnunet.php3
===================================================================
--- GNUnet-docs/WWW/user_gnunet.php3    2007-08-06 21:26:59 UTC (rev 5418)
+++ GNUnet-docs/WWW/user_gnunet.php3    2007-08-06 22:42:32 UTC (rev 5419)
@@ -55,19 +55,20 @@
 PRE("# gnunet-update\n");
 BP();
 W("This should trigger all necessary changes.");
-W("If you are updating from a version before 0.7.0pre2, you must delete your 
old GNUnet directories.");
 W("Note that you will also have to run <tt>gnunet-update</tt> after certain 
changes to the <tt>gnunetd.conf</tt> configuration file.");
 W("<tt>gnunetd</tt> will immediately exit with an error message if 
<tt>gnunet-update</tt> must be run.");
-
 P();
-
 W("If you are using GNUnet for the first time (or if you deleted all of your 
old files) you will probably want to run <tt>gnunet-setup</tt> at this point.");
 W("The setup tool supports various styles of user interfaces.");
 W("Invoke <tt>gnunet-setup</tt> without arguments to see the various styles 
supported on your platform.");
+W("You should run <tt>gnunet-setup</tt> with the <tt>-d</tt> option in order 
to configure <tt>gnunetd</tt>.");
+W("Unless you specify a different location with the <tt>-c</tt> option, the 
<tt>gnunetd</tt> configuration will be stored in <tt>/etc/gnunetd.conf</tt>.");
+W("In order to enable <tt>gnunet-setup</tt> to edit that file, you should run 
it as user <tt>root</tt>:");
+EP();
+PRE("# gnunet-setup -d wizard-gtk\n");
+BP();
 W("Using one of the wizards should allow a quick initial configuration.");
-
 P();
-
 W("After finishing the configuration with <tt>gnunet-setup</tt>, you can test 
the installation using");
 EP();
 PRE("# gnunet-transport-check\n");
@@ -82,8 +83,10 @@
 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 any errors, you may have to edit the configuration file.");
+W("If you get any errors, you may have to edit the configuration file:");
+EP();
+PRE("# gnunet-setup -d gconfig\n");
+BP();
 W("Some errors maybe related to the specific applications that are being used, 
so consult the documentation there.");
 W("Use the log-files and the tools described below to diagnose problems.");
 W("You may also want to increase the verbosity of the logging using the 
parameter &quot;-L DEBUG&quot;.");
@@ -118,7 +121,7 @@
 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("When a required configuration file is not present on startup, any GNUnet 
tool will attempt to create one by running <tt>gnunet-setup 
generate-defaults</tt> which dumps a copy of the default configuration file to 
<tt>~/.gnunet/gnunet.conf</tt>.");
 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.");
 W("The rationale is that typcially the system administrator will setup 
<tt>gnunetd</tt> while ordinary users are executing the clients.");
@@ -150,9 +153,9 @@
   ARRAY(extlink_("#gnunet.conf.trusted", "TRUSTED"),
        extlink_("#gnunet.conf.blacklist", "BLACKLIST"),
        extlink_("#gnunet.conf.heloexchange", "HELLOEXCHANGE")));
-P();
-W("The configuration of the SMTP transport layer is described %s",
-  intlink_("smtp.php3","here"));
+//P();
+//W("The configuration of the SMTP transport layer is described %s",
+//  intlink_("smtp.php3","here"));
 EP();
 
 ANCHOR("gnunet.conf.port");H4("NETWORK: PORT");
@@ -187,15 +190,6 @@
   extlink_("http://www.technopagan.org/dynamic/";, "Dynamic DNS"));
 
 EP();
-ANCHOR("gnunet.conf.helloexchange");H4("NETWORK: HELLOEXCHANGE");
-
-BP();
-W("If you set this option to <tt>NO</tt> your node will not forward HELLO 
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.");
-
-EP();
 ANCHOR("gnunet.conf.trusted");H4("NETWORK: TRUSTED");
 
 BP();
@@ -203,7 +197,9 @@
 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.");
-
+W("The format of this option is <tt>IP/NETWORK;</tt>.");
+W("Multiple entries (seperated and terminated by a semicolon) are permitted.");
+W("The network can be specified using a bitmask (for example, 
<tt>/255.255.0.0</tt>) or the number of bits (for example, <tt>/16</tt>).");
 EP();
 ANCHOR("gnunet.conf.interfaces");H4("LOAD: INTERFACES");
 
@@ -279,6 +275,9 @@
 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.");
+W("The format of this option is <tt>IP/NETWORK;</tt>.");
+W("Multiple entries (seperated and terminated by a semicolon) are permitted.");
+W("The network can be specified using a bitmask (for example, 
<tt>/255.255.0.0</tt>) or the number of bits (for example, <tt>/16</tt>).");
 
 EP();
 ANCHOR("gnunet.conf.udp.mtu");H4("UDP: MTU");
@@ -312,6 +311,9 @@
 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.");
+W("The format of this option is <tt>IP/NETWORK;</tt>.");
+W("Multiple entries (seperated and terminated by a semicolon) are permitted.");
+W("The network can be specified using a bitmask (for example, 
<tt>/255.255.0.0</tt>) or the number of bits (for example, <tt>/16</tt>).");
 
 EP();
 ANCHOR("gnunet.conf.tcp.mtu");H4("TCP: MTU");
@@ -343,15 +345,6 @@
 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.");
 
 EP();
-ANCHOR("gnunet.conf.helloexpires");H4("GNUNETD: HELLOEXPIRES");
-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).");
-
-EP();
 ANCHOR("gnunet.conf.loglevel");H4("LOGGING: USER-LEVEL and ADMIN-LEVEL");
 
 BP();