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

[grothoff]

Author: grothoff
Date: 2005-05-01 07:16:55 -0700 (Sun, 01 May 2005)
New Revision: 717

Modified:
   GNUnet-docs/WWW/user_afs.php3
Log:
docs

Modified: GNUnet-docs/WWW/user_afs.php3
===================================================================
--- GNUnet-docs/WWW/user_afs.php3       2005-05-01 13:58:45 UTC (rev 716)
+++ GNUnet-docs/WWW/user_afs.php3       2005-05-01 14:16:55 UTC (rev 717)
@@ -109,12 +109,12 @@
 W("Note that the UI may not always be very pretty for collections since this 
is a new feature.");
 P();
 
-ANCHOR("configuration");H3("AFS options in gnunet.conf");
+ANCHOR("configuration");H3("File-sharing options in gnunet.conf");
 
 W("This section describes the options in gnunet.conf that relate to anonymous 
file sharing.");
 W("Most options are in the configuration file for the gnunetd daemon, the 
others are specfically marked as client options.");
 
-ANCHOR("gnunet.conf.diskquota");H4("AFS: DISKQUOTA");
+ANCHOR("gnunet.conf.diskquota");H4("FS: DISKQUOTA");
 
 W("Use this option to specify how much space GNUnet is allowed to use on the 
drive.");
 W("This does not include indexed files.");
@@ -127,68 +127,17 @@
 
 
 P();
-ANCHOR("gnunet.conf.indexdirectory"); H4("AFS: INDEX-DIRECTORY");
+ANCHOR("gnunet.conf.indexdirectory"); H4("FS: INDEX-DIRECTORY");
 
 W("This option specifies the name of the directory where indexed files are 
either copied to or symlinked from.");
 W("When a file is indexed with the option <tt>-l</tt> and if <tt>gnunetd</tt> 
and the inserting process run on the same machine, then a symbolic link is 
created from the index-directory to that file.");
 W("Without the <tt>-l</tt> option or if <tt>gnunetd</tt> runs on a different 
machine, a copy of the file is made instead.");
 W("Note that the indexing process does a lot more than just this, thus moving 
files over to the index directory by hand will NOT share these files.");
 
-P();
-ANCHOR("gnunet.conf.indexquota"); H4("AFS: INDEX-QUOTA");
-W("This option specifies the maximum size of the copied (!) files in the index 
directory.");
-W("Note that files that were indexed with the <tt>-l</tt> option on the local 
machine do not count towards the quota.");
-W("The quota is used to limit the amount of data that users can copy to the 
index directory.");
-W("It is separate from the normal QUOTA which applies to inserted (not 
indexed) and migrated content.");
 
-
-
 P();
-ANCHOR("gnunet.conf.anonymity-receive");H4("AFS: ANONYMITY-RECEIVE");
+ANCHOR("gnunet.conf.activemigration");H4("FS: ACTIVEMIGRATION");
 
-W("With this option you can specify the required degree of receiver 
anonymity.");
-W("If set to zero, GNUnet will try to download the file as fast as possible 
without any additional slowdown by the anonymity code due to a lack of 
traffic.");
-W("Note that you will still have a fairly high degree of anonymity due to 
link-to-link encryption, small uniform messages, pseudo-random routing and 
random delays.");
-W("Still, your anonymity will depend on the current network load if the 
adversary is powerful enough to monitor most of your traffic.");
-W("The download is still unlikely to be terribly fast since the sender may 
have requested sender-anonymity and since in addition to that, GNUnet will 
still do the anonymous routing.");
-BR();
-
-W("This option can be used to further limit the number of requests that are 
send out to the network.");
-W("In particular, you can require GNUnet to receive certain amounts of traffic 
from other peers before sending your queries.");
-W("This way, you can gain very high levels of anonymity - at the expense of 
much more traffic and much higher latency.");
-W("Since downloads are likely to quickly get very slow or even stop entirely, 
set it only if you really believe you need the strongest possible anonymity.");
-BR();
-
-W("The definition of ANONYMITY-RECEIVE is the following:");
-BR();
-echo "<ul><li>";
-W("If the value v is smaller than 1000, it means that if GNUnet routes n bytes 
of messages from foreign peers, it may originate n/v bytes of queries in the 
same time-period.");
-W("The time-period is twice the average delay that GNUnet deferrs forwarded 
queries.");
-echo "</li><li>";
-W("If the value v is larger or equal to 1000, it means that if GNUnet routes n 
bytes of QUERIES from at least (v MOD 1000) peers, it may originate n/v/1000 
bytes of queries in the same time-period.");
-echo "</li></ul>";
-BR();
-
-W("The default is 0 and this should be fine for most users.");
-W("Also notice that if you choose high values, especially above 1000, you may 
end up having no throughput at all, especially if many of your fellow 
GNUnet-peers do the same.");
-
-P();
-ANCHOR("gnunet.conf.anonymity-send");H4("AFS: ANONYMITY-SEND");
-
-W("You can also request a certain degree of anonymity for the files and blocks 
that you are sharing.");
-W("In this case, only a certain faction of the traffic that you are routing 
will be allowed to be replies that originate from your machine.");
-W("Again, 0 means unlimited.");
-BR();
-
-W("The semantics of ANONYMITY-SEND are equivalent to the semantics of %s",
-  extlink_("#gnunet.conf.anonymity-receive","ANONYMITY-RECEIVE"));
-BR();
-
-W("The default is 0 and this should be fine for most users.");
-
-P();
-ANCHOR("gnunet.conf.activemigration");H4("AFS: ACTIVEMIGRATION");
-
 W("Setting this option to <tt>YES</tt> allows <tt>gnunetd</tt> to migrate data 
to the local machine.");
 W("Setting this option to <tt>YES</tt> is highly recommended for efficiency.");
 W("Its also the default.");
@@ -198,7 +147,7 @@
 W("Note that in either case, your anonymity would have to be broken first 
(which may be possible depending on the size of the GNUnet network and the 
strength of the adversary).");
 
 P();
-ANCHOR("gnunet.conf.searchtimeout");H4("AFS: SEARCHTIMEOUT");
+ANCHOR("gnunet.conf.searchtimeout");H4("FS: SEARCHTIMEOUT");
 
 W("This is a client option respected by <tt>gnunet-search</tt> and 
<tt>gnunet-gtk</tt>.");
 w("After how many seconds should <tt>gnunet-search</tt> give up searching?");
@@ -208,7 +157,7 @@
 W("The default is 300 seconds.");
 
 P();
-ANCHOR("gnunet.conf.extractors");H4("AFS: EXTRACTORS");
+ANCHOR("gnunet.conf.extractors");H4("FS: EXTRACTORS");
 
 W("This is a client option respected by <tt>gnunet-insert</tt> and 
<tt>gnunet-gtk</tt>.");
 W("This option specifies which additional extractors <tt>gnunet-insert</tt> 
should use for keyword extraction.");
@@ -216,71 +165,17 @@
 W("Typically, an extractor for splitting keywords at word boundaries is added 
here.");
 
 P();
-ANCHOR("gnunet.conf.databasetype");H4("AFS: DATABASETYPE");
+ANCHOR("gnunet.conf.databasetype");H4("MODULES: sqstore");
 
 W("Which database type should be used for content?");
-W("Valid types are &quot;gdbm&quot;, &quot;tdb&quot;, &quot;bdb&quot;, 
&quot;mysql&quot;, &quot;sqlite&quot; and &quot;directory&quot;.");
+W("Valid types are &quot;sqstore_sqlite&quot; and &quot;sqstore_mysql&quot;.");
 W("The libraries and header files for the specified type must have been 
available at compile time.");
-W("");
-W("Only &quot;directory&quot; is guaranteed to be available on all systems.");
-W("If the type is changed, you must stop <tt>gnunetd</tt> and run 
<tt>gnunet-convert</tt> to convert the database.");
+W("If the type is changed, you must stop <tt>gnunetd</tt> and run 
<tt>gnunet-update</tt> to convert the database.");
 BR();
-
-W("Here are some performance numbers for the databases from Eric Haumant (for 
a 100 MB file with random content):");
-P();
-?>
-<center>
-<table border=5>
- <tr>
-  <th><?php W("Database"); ?></th>
-  <th><?php W("Upload Speed"); ?></th>
-  <th><?php W("Download Speed"); ?></th>
-  <th><?php W("Space used"); ?></th>
- </tr>
- <tr>
-  <td><?php W("mysql"); ?></td>
-  <td><?php W("400 kb/s"); ?></td>
-  <td><?php W("300 kb/s"); ?></td>
-  <td><?php W("113 MB"); ?></td>
- </tr>
-</table>
-</center>
-<?php
-W("Nils Durner compared the new SQLite database with bdb:");
-?>
-<center>
-<table border=5>
- <tr>
-  <th><?php W("Database"); ?></th>
-  <th><?php W("Upload Speed (73 MB file)"); ?></th>
-  <th><?php W("Upload Speed (279 MB file)"); ?></th>
-  <th><?php W("Space used (73 MB file)"); ?></th>
-  <th><?php W("Space used (279 MB file)"); ?></th>
- </tr>
- <tr>
-  <td><?php W("SQLite"); ?></td>
-  <td><?php W("70,562 kb/s"); ?></td>
-  <td><?php W("24,255 kb/s"); ?></td>
-  <td><?php W("91,4 MB"); ?></td>
-  <td><?php W("348,9 MB"); ?></td>
- </tr>
-</table>
-</center>
-<?php
-W("Note that these numbers may be slightly different between different 
machines and different versions of GNUnet.");
-W("Nevertheless, they should help you pick the right database for you (the 
choice is between work required to do the setup vs. performance).");
 W("The <tt>mysql</tt> module requires manual setup, described %s.",
   extlink_("#mysql","here"));
 W("The sqlite databases only requires the installation of the respective 
database (with header files) before running configure.");
 
-ANCHOR("gnunet.conf.content-priority");H4("GNUNET-INSERT: CONTENT-PRIORITY");
-
-W("What is the initial priority of content that is locally inserted?");
-W("Default is 65535 which is <em>very high</em> (every day, content ages by 2 
points; thus inserting content at 65535 will make it age to 
<em>unimportant</em> in about 100 years).");
-P();
-HR();
-P();
-
 ANCHOR("mysql");H4("Setting up the mysql database");
 
 W("Note: The mysql module does NOT work with mysql v3.23.49 due to a bug in 
mysql.");
@@ -373,7 +268,7 @@
 
 
 
-ANCHOR("commands");H3("Commands for Anonymous File Sharing");
+ANCHOR("commands");H3("Commands for File Sharing");
 
 IMG("afs_small.png", "Anonymous file sharing logo", "RIGHT", 150, 115);
 W("The only useful application that is currently available for GNUnet is 
anonymous file-sharing.");
@@ -386,12 +281,17 @@
 W("The command <tt>gnunet-insert</tt> can be used to add content to the 
network.");
 W("The basic format of the command is");
 
-PRE("# gnunet-insert [-n] [-k KEYWORDS]* [-D Description] FILENAME 
[FILENAMES]*");
+PRE("$ gnunet-insert [-n] [-k KEYWORDS]* [-m TYPE:VALUE] FILENAME 
[FILENAMES]*");
 
 W("The option -k is used to specify keywords for the file that should be 
inserted.");
 W("You can supply any number of keywords, and each of the keywords will be 
sufficient to locate and retrieve the file.");
-W("The description (option -D, text with spaces must be in quotes) is 
displayed to other users when they select which files to download.");
-W("The description and the keywords are optional and can be inferred if you 
have %s installed and libextractor is able to infer keywords and a description 
from the file.",
+W("The -m option is used to specify meta-data, such as descriptions.");
+W("You can use -m multiple times.");
+W("The TYPE passed must be from the list of meta-data types known to 
libextractor.");
+W("You can obtain this list by running <tt>extract -l</tt>.");
+W("Use quotes around the entire meta-data argument if the value contains 
spaces.");
+W("The meta-data is displayed to other users when they select which files to 
download.");
+W("The meta-data and the keywords are optional and maybe inferred by %s.",
   intlink_("/libextractor/index.php", "libextactor"));
 P();
 
@@ -428,18 +328,18 @@
 W("The command <tt>gnunet-search</tt> can be used to search for content on 
GNUnet.");
 W("The format is:");
 
-PRE("# gnunet-search [-t TIMEOUT] KEYWORD [AND KEYWORD]*");
+PRE("$ gnunet-search [-t TIMEOUT] KEYWORD [AND KEYWORD]*");
 
 W("The -t option specifies that the query should timeout after approximately 
TIMEOUT seconds.");
 W("A value of zero is interpreted as <i>no timeout</i>.");
 W("If multiple words are passed as keywords and are <strong>not</strong> 
separated by an <tt>AND</tt>, gnunet-search will concatenate them to one bigger 
keyword.");
 W("Thus,");
 
-PRE("# gnunet-search Das Kapital");
+PRE("$ gnunet-search Das Kapital");
 
 W("and");
 
-PRE("# gnunet-search \"Das Kapital\"");
+PRE("$ gnunet-search \"Das Kapital\"");
 
 W("are identical.");
 W("You can use AND to separate keywords.");
@@ -448,7 +348,7 @@
 
 P();
 W("Search results are printed by gnunet-search like this:");
-PRE("gnunet-download -o &quot;COPYING&quot; -- 
gnunet://afs/N8RCF3TETLRU9CV1PAS7M2H9QDB36AE3.K9JO8IP7KTNFO23S3VB4TFUKLD7SO5AS.0466DC92.17992\n"
 .
+PRE("$ gnunet-download -o &quot;COPYING&quot; -- 
gnunet://afs/N8RCF3TETLRU9CV1PAS7M2H9QDB36AE3.K9JO8IP7KTNFO23S3VB4TFUKLD7SO5AS.0466DC92.17992\n"
 .
     "=&gt; The GNU Public License &lt;= (mimetype: text/plain)");
 
 W("The first line is the command you would have to enter to download the 
file.");
@@ -463,11 +363,11 @@
 ANCHOR("gnunetdownload");H4("gnunet-download");
 W("In order to download a file, you need the three values returned by 
<tt>gnunet-search</tt>.");
 W("You can then use the tool <tt>gnunet-download</tt> to obtain the file:");
-PRE("# gnunet-download -f FILENAME -- GNUNETURL");
+PRE("$ gnunet-download -f FILENAME -- GNUNETURL");
 W("FILENAME specifies the name of the file where GNUnet is supposed to write 
the result.");
 W("Existing files are overwritten.");
 W("If you want to download the GPL from the previous example, you do the 
following:");
-PRE("# gnunet-download -o \"COPYING\" -- 
gnunet://afs/N8RCF3TETLRU9CV1PAS7M2H9QDB36AE3.K9JO8IP7KTNFO23S3VB4TFUKLD7SO5AS.0466DC92.17992");
+PRE("$ gnunet-download -o \"COPYING\" -- 
gnunet://afs/N8RCF3TETLRU9CV1PAS7M2H9QDB36AE3.K9JO8IP7KTNFO23S3VB4TFUKLD7SO5AS.0466DC92.17992");
 W("If you ever have to abort a download, you can continue it at any time by 
re-issuing <tt>gnunet-download</tt> with the same filename.");
 W("In that case, GNUnet will <strong>not</strong> download blocks again that 
are already present.");
 W("GNUnet&rsquo;s %s will ensure file integrity, even if the existing file was 
not downloaded from GNUnet in the first place.",
@@ -486,7 +386,6 @@
 W("<tt>gnunet-delete</tt> can be used to un-index files that were inserted 
into GNUnet (works only for files that were inserted locally and that are still 
present on the local drive).");
 
 ANCHOR("gnunetdirectory");H4("gnunet-directory");
-W("Since version 0.5.5 GNUnet supports directories.");
 W("Directories are shared just like ordinary files.");
 W("If you download a directory with <tt>gnunet-download</tt>, you can use 
<tt>gnunet-directory</tt> to list its contents.");
 W("The contents of a directory are File Identifiers (FIs).");
@@ -496,12 +395,8 @@
 W("In order to make it possible to assemble directories, GNUnet stores all 
locally known FIs in a plaintext database, the FI database.");
 
 P("This <tt>gnunet-directory</tt> can also be used to list the contents of the 
FI database.");
-W("The FI database is organized into four categories.");
-W("The categorization of the entries of the FI database is used to specify 
where the FI was originally from.");
-W("The categories are insertion (locally inserted file), search result, 
namespace entry and directory (a directory was downloaded and displayed with 
<tt>gnunet-gtk</tt> or <tt>gnunet-directory</tt> and the FI was part of that 
listing).");
-W("The option <tt>-a</tt> causes the display of all known FI entries in all 
categories.");
-W("Entries from a specific category can be printed with the respective letter 
option.");
-W("The corresponding capital letter options remove all entries from a given 
category.");
+W("The option <tt>-l</tt> causes the display of all known FI entries.");
+W("The FI database can be flushed using the <tt>-k</tt> option.");
 W("There is currently no way to selectively remove a specific entry.");
 
 HR();
@@ -517,13 +412,6 @@
 W("A pseudonym is the virtual identity of the entity in control of a 
namespace.");
 W("Anyone can create any number of pseudonyms.");
 W("Note that creating a pseudonym can take a few minutes depending on the 
performance of the machine used.");
-W("Pseudonyms can be encrypted with a password.");
-W("The password is then used to additionally encrypt the key of the 
pseudonym.");
-W("A password is only useful if the local GNUnet-directory may be potentially 
exposed to an adversary who would like to cease control of the namespace.");
-W("If the local disk is private and not seriously threatened, not using any 
password protection for a pseudonym is acceptable.");
-W("If password protection is desired, use the &quot;-p&quot; option to specify 
a password.");
-W("There is currently no tool to change a password, but it should not be 
difficult to write one.");
-W("The ID of an encrypted pseudonym can only be listed if the respective 
password is specified.");
 P();
 W("With the <tt>-D NICK</tt> option pseudonyms can be deleted.");
 W("Once the pseudonym has been deleted it is impossible to add content to the 
corresponding namespace.");
@@ -546,10 +434,9 @@
 W("While the namespace is uniquely identified by its ID, another way to refer 
to the namespace is to use the NICKNAME.");
 W("The NICKNAME can be freely chosen by the creator of the namespace and hence 
conflicts are possible.");
 W("If a GNUnet client learns about more than one namespace using the same 
NICKNAME, the ID is appended to the NICKNAME go get a unique identifier.");
-W("The advertisement also contains various optional descriptions of the 
content of the namespace.");
-W("More specifically, it contains a DESCRIPTION (text), a CONTACT address 
(e-mail), a URI (where to find more information), a MIME-TYPE (what is the 
primary type of the data in the namespace) and a NAME (the name of the creator 
in real-life).");
+W("The advertisement also contains meta-data describing the content of the 
namespace.");
 W("Naturally all of this information is <tt>optional</tt> and maybe 
<tt>incorrect</tt> since it is provided by the user and cannot be verified.");
-W("Another item of particular interest in the namespace advertisement is the 
ROOT.");
+W("An item of particular interest in the namespace advertisement is the 
ROOT.");
 W("The ROOT is the identifier of a designated file in the namespace.");
 W("The idea is that the ROOT can be used to advertise an entry point to the 
content of the namespace.");
 P();
@@ -560,6 +447,8 @@
 
 P();
 ANCHOR("GUI");H4("gnunet-gtk");
+W("<tt>gnunet-gtk</tt> is not yet available for GNUnet 0.7.x.");
+/*
 W("<tt>gnunet-gtk</tt> is the GTK+ interface for GNUnet.");
 W("It can currently only be used to search for and download files from the 
network.");
 W("gnunet-gtk can also be used to insert files into the network.");
@@ -630,5 +519,6 @@
 W("Just as <tt>gnunet-pseudonym</tt> can print a list of all known namespace 
advertisements, the namespace search in <tt>gnunet-gtk</tt> offers access to 
the list of advertised namespaces and the respective meta-data.");
 IMG("gnunet-namespace-search.png", "Searching a namespace.", "CENTER", 658, 
348);
 P();
+*/
 include("html_footer.php3");
 ?>