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

[grothoff]

Author: grothoff
Date: 2005-07-12 12:53:06 -0700 (Tue, 12 Jul 2005)
New Revision: 1417

Added:
   GNUnet-docs/WWW/gnunetgtk.php3
Log:
update

Added: GNUnet-docs/WWW/gnunetgtk.php3
===================================================================
--- GNUnet-docs/WWW/gnunetgtk.php3      2005-07-12 19:50:08 UTC (rev 1416)
+++ GNUnet-docs/WWW/gnunetgtk.php3      2005-07-12 19:53:06 UTC (rev 1417)
@@ -0,0 +1,117 @@
+<?php
+include("scripts.php3");
+$title = "GNUnet Documentation: gnunet-gtk";
+$description="Configuring and using gnunet-gtk";
+include("html_header.php3");
+H2("gnunet-gtk");
+
+BP();
+W("<tt>gnunet-gtk</tt> is the GTK+ interface for GNUnet.");
+W("<tt>gnunet-gtk</tt> is highly customizable and uses a plugin architecture 
to load code that will support the various GNUnet applications.");
+W("The basic plugins are &quot;about&quot;, &quot;daemon&quot; and 
&quot;stats&quot;.");
+W("These plugins implement the about dialog, the interaction with 
<tt>gnunetd</tt> (start, stop, status) and visualization of statistics obtained 
from <tt>gnunetd</tt>.");
+W("In addition, plugins can be loaded for specific peer-to-peer 
applications.");
+W("In particular, the &quot;fs&quot; plugin provides the user interface for 
file-sharing.");
+W("Which plugins are loaded is configured in the <tt>gnunet.conf</tt> 
configuration file in section <tt>GNUNET-GTK</tt> under <tt>PLUGINS</tt>.");
+
+P();
+W("After <tt>gnunet-gtk</tt> was started, you should see something like the 
following:");
+//IMG("gtk7-startup.png","GNUnet GTK startup window","CENTER",788,332);
+W("Which options appear on top depends on the set of plugins that are selected 
in the configuration file.");
+
+EP();
+
+ANCHOR("about");
+H2("The about plugin");
+
+ANCHOR("daemon");
+H2("The daemon plugin");
+
+ANCHOR("stats");
+H2("The stats plugin");
+
+
+ANCHOR("fs");
+H2("The fs (file-sharing) plugin");
+
+ANCHOR("fs-status");
+H3("Status");
+
+ANCHOR("fs-search");
+H3("Searching and Downloading");
+
+W("Enter the query into the input line at the bottom and click on search.");
+W("A register card will open in the main window.");
+W("In that card, search results obtained from the network will be listed once 
they arrive.");
+W("<tt>gnunet-gtk</tt> will keep searching for the query until you close that 
card.");
+W("No duplicate results will be displayed.");
+
+IMG("gtk-search.png", "This window displays the search results", "CENTER", 
788, 332);
+
+W("You can enter additional queries or select a file to download from the 
list.");
+W("The size of the file is displayed in bytes.");
+W("Mind that the description was supplied by the user inserting the file and 
may not be accurate.");
+W("After you click on the download button, the entry selected will be removed 
from the results list and a dialog will prompt you for the filename that you 
want to give to the file.");
+W("If you choose an existing file, that file will be overwritten without any 
warnings.");
+W("If the existing file contains the same data (even in parts) as the file 
that you are trying to download, those parts will not be downloaded again.");
+W("You can use this feature to continue downloads that were incomplete.");
+W("After you gave a filename, click on <i>ok</i>.");
+W("The dialog will disappear and <tt>gnunet-gtk</tt> will start the 
download.");
+W("The download overview window shows the progress for each download:");
+
+IMG("gtk-downloads.png", "download progress", "CENTER", 788, 332);
+
+W("You can abort downloads by selecting them in this window and clicking on 
&quot;Remove selected entries&quot;.");
+W("This will leave the parts of the file that were already downloaded on the 
drive.");
+W("Closing the download list does not affect the downloads, they will continue 
in the background.");
+W("But note that exiting <tt>gnunet-gtk</tt> will implicitly abort all 
downloads.");
+W("Be advised that the download usually starts very slowly, then speeds up, 
and eventually declines a bit again at the end.");
+W("This is perfectly normal.");
+W("Go get a coffee while doing the download -- or do a couple in parallel.");
+W("GNUnet uses a lot more time (but not that much more bandwidth) because it 
delays processing to make traffic analysis hard.");
+W("Even downloading a file from your local harddrive (that you inserted 
yourself) can take a couple of minutes!");
+W("The good news is that the delays currently experienced are likely to become 
smaller whenever the traffic on GNUnet increases.");
+W("This is one of the reasons why the download is fastest in the middle of the 
process.");
+EP();
+
+ANCHOR("fs-upload");
+H3("Uploading");
+
+BP();
+
+W("In order to insert a file, use the <tt>File</tt> menu.");
+W("A dialog will pop up and prompt you to choose the file to insert:");
+IMG("gtk-insert.png", "choose file to insert", "CENTER",451,415);
+P();
+W("Select the file and press <tt>ok</tt>.");
+W("Next you will have to provide a description and keywords and choose if you 
want to <tt>index</tt> or <tt>insert</tt> the file (choose index if the file 
will not be moved or deleted to safe space):");
+IMG("gtk-insert2.png", "choose file to insert", "CENTER",408, 428);
+P();
+IMG("gtk-insert3.png", "adding keywords", "CENTER",408,428);
+P();
+W("Finally, press ok and watch GNUnet making the file available:");
+IMG("gtk-inserting.png", "insertion in progress", "CENTER", 178, 73);
+P();
+W("You can search, insert and download in parallel:");
+IMG("gtk-bigshot.png", "The big picture.", "CENTER", 599, 427);
+
+W("<tt>gnunet-gtk</tt> also allows you to handle directories.");
+W("Downloading a directory automatically opens the contents of the directory 
in a new frame in the notebook.");
+
+ANCHOR("fs-advanced");
+H3("Advanced File Sharing");
+
+W("You can create and insert a new directory from the known FIs in the FI 
database using <tt>advanced-assemble directory</tt>.");
+IMG("gtk-assemble-directory.png", "assemble a directory", "CENTER", 628, 508);
+P();
+W("Pseudonyms, the public-private key pair that allows publishing documents in 
a namespace can also be managed with <tt>gnunet-gtk</tt>.");
+W("The functionality provided is equivalent to <tt>gnunet-pseudonym</tt>.");
+W("Once a pseudonym has been created, files and directories can be placed in 
the namespace defined by the pseudonym.");
+IMG("gnunet-gtk-namespace.png", "Inserting into a namespace.", "CENTER", 788, 
608);
+W("<tt>gnunet-gtk</tt> also offers the option to search a given namespace.");
+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);
+EP();
+
+include("html_footer.php3");
+?>