[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] r1484 - GNUnet-docs/WWW
|
From: |
grothoff |
|
Subject: |
[GNUnet-SVN] r1484 - GNUnet-docs/WWW |
|
Date: |
Wed, 13 Jul 2005 19:44:29 -0700 (PDT) |
Author: grothoff
Date: 2005-07-13 19:44:26 -0700 (Wed, 13 Jul 2005)
New Revision: 1484
Modified:
GNUnet-docs/WWW/gnunetgtk.php3
Log:
gtk
Modified: GNUnet-docs/WWW/gnunetgtk.php3
===================================================================
--- GNUnet-docs/WWW/gnunetgtk.php3 2005-07-13 19:39:53 UTC (rev 1483)
+++ GNUnet-docs/WWW/gnunetgtk.php3 2005-07-14 02:44:26 UTC (rev 1484)
@@ -6,7 +6,6 @@
H2("gnunet-gtk");
BP();
-echo "NOTE TO THE READER: THIS TEXT IS CURRENTLY BEING ACTIVELY REVISED.";
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 "about", "daemon" and
"stats".");
@@ -17,101 +16,142 @@
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);
+IMG("gnunet-gtk-welcome.png","GNUnet GTK welcome window","CENTER",732,464);
W("Which options appear on top depends on the set of plugins that are selected
in the configuration file.");
-
+W("The following plugins are currently available:");
+echo "<ul>\n";
+LILI("#about", "About");
+LILI("#daemon", "Daemon");
+LILI("#fs", "File-sharing");
+LILI("#stats", "Statistics");
+echo "</ul>\n";
EP();
ANCHOR("about");
H2("The about plugin");
-
+BP();
+W("This plugin is responsible for making the "About" button on the
welcome screen work.");
+W("Note that the plugin requires libglade 2.10 or higher to work properly.");
+EP();
ANCHOR("daemon");
H2("The daemon plugin");
+BP();
+W("The daemon plugin enables the "General" menu.");
+W("This menu can be used to control <tt>gnunetd</tt>.");
+IMG("gnunet-gtk-daemon.png",
+ "gnunet-gtk daemon page",
+ "RIGHT",732,464);
+W("The "Start" and "Stop" buttons can be used to start or
kill the <tt>gnunetd</tt> process.");
+W("Note that stop may kill <tt>gnunetd</tt> even if <tt>gnunetd</tt> is
running on another machine, while start is only able to start the process on
the local machine.");
+W("If <tt>gnunetd</tt> is running, the "Start"-button will not be
active.");
+W("Similarly, if <tt>gnunetd</tt> is not running, the "Stop"-button
will not be active.");
+W("If either of the buttons has been pressed, both will be deactivated for a
while to give <tt>gnunetd</tt> time to start or shutdown.");
+W("The little round light to the right of the buttons indicates the current
status of <tt>gnunetd</tt>.");
+W("It is green if the daemon is running and red if the daemon is not
running.");
+P();
+W("Finally, the page lists the application modules that <tt>gnunetd</tt> has
currently loaded, together with a description of each application.");
+EP();
-ANCHOR("stats");
-H2("The stats plugin");
ANCHOR("fs");
H2("The fs (file-sharing) plugin");
-
+BP();
+W("The "fs" plugin is responsible for managing file-sharing with
<tt>gnunet-gtk</tt>.");
+W("The plugin provides four sub-menus:");
+echo "<ul>\n";
+LILI("#fs-status", "Status");
+LILI("#fs-search", "Searching and Downloading");
+LILI("#fs-upload", "Upload");
+LILI("#fs-advanced", "Advanced");
+echo "</ul>\n";
+EP();
ANCHOR("fs-status");
H3("Status");
+BP();
+W("The status tab gives an overview of the current file-sharing activities.");
+IMG("gnunet-gtk-fs-status.png",
+ "gnunet-gtk file-sharing status page",
+ "RIGHT",732,464);
+W("It lists the various active searches with the number of search results for
each search.");
+P();
+W("The download list shows active downloads and how far they have
progressed.");
+W("The download list can also be used to abort downloads.");
+W("The "Clear"-button can be used to clear completed downloads from
the list (the downloaded files will not be deleted).");
+P();
+W("Finally the upload list shows active uploads and their progress.");
+W("Uploads cannot be aborted.");
+EP();
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
"Remove selected entries".");
-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.");
+BP();
+IMG("gnunet-gtk-fs-search.png",
+ "gnunet-gtk file-sharing search and download page",
+ "RIGHT",732,464);
+W("In order to start a search, enter a keyword into the input line at the top
and click on search.");
+W("If a namespace should be searched, change the selection in the selection
box on the right from "globally" to some namespace identifier.");
+W("The search results will be displayed in a tab that has the same name as the
query.");
+W("Mind that the metadata shown was supplied by the user that uploaded the
file and may not always be accurate.");
+W("The search query will be repeated in the background as long as the tab is
open.");
+W("Duplicate results will not be displayed.");
+W("Starting another search with the same query will merely bring the existing
tab into focus.");
+W("The "Anonymity" spin button to the right of the search line can
be used to specify the desired level of anonymity for the search.");
+P();
+W("The tab contains a list with the search results and a button that can be
used to initiate the download of selected files.");
+W("Note that it is possible to specify a different level of anonymity for the
download using the anonymity spin button next to the
"Download"-button.");
+W("The "Close"-button closes the search window.");
+P();
+W("If a directory is downloaded, the contents of the directory will be shown
in the search window.");
+W("Click on the little triangle that appears to the left of the name to show
the contents of the directory.");
+W("Files (and other directories) contained in the directory can be downloaded
just like the search results using the "Download" button.");
+P();
+W("Downloaded files will be saved in the directory specified in the
<tt>gnunet.conf</tt> configuration file (default is
<tt>/tmp/gnunet-downloads/</tt>).");
+P();
+W("Again, you can abort downloads using the "Status" tab.");
+W("If you exit <tt>gnunet-gtk</tt>, all active downloads and searches will be
frozen.");
+W("Then, the next time you restart <tt>gnunet-gtk</tt>, they will
automatically continue.");
EP();
ANCHOR("fs-upload");
H3("Uploading");
BP();
+IMG("gnunet-gtk-fs-upload.png",
+ "gnunet-gtk file-sharing upload page",
+ "RIGHT",732,464);
-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("In order to upload a file to GNUnet, you should first choose between
insertion and indexing.");
+W("If you want to upload an entire directory tree, select
"recursive;".");
+W("You can the enter a filename or use the "Browse" button to browse
the local filesystem for files.");
+W("Finally, press the "Upload" button.");
+W("This will open another dialog in which you can provide metadata about the
file.");
+W("The dialog will likely already contain metadata that was inferred by %s.",
+ intlink_("http://gnunet.org/libextractor/index.php";, "libextractor"));
+W("Feel free to add additional keywords, descriptions or even change the
preview.");
+W("Note that the total size of the metadata must be below 60.000 bytes, so
large previews will not work.");
+W("Once you have completed the metadata dialog, the upload will start.");
+W("You can watch its progress in the status tab.");
+EP();
-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");
+BP();
+W("This tab still needs to be documented.");
+EP();
-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);
+
+ANCHOR("stats");
+H2("The stats plugin");
+
+BP();
+IMG("gnunet-gtk-fs-stats.png",
+ "gnunet-gtk statistics page",
+ "RIGHT",732,464);
+W("This page visualizes various statistics of the current <tt>gnunetd</tt>
process.");
+W("You can configure the speed at which the window updates using the
STATS-INTERVAL option in <tt>gnunet.conf</tt> (in section
<tt>GNUNET-GTK</tt>).");
+W("The information shown corresponds to (some of) the data shown by
<tt>gnunet-stats</tt>.");
EP();
include("html_footer.php3");
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [GNUnet-SVN] r1484 - GNUnet-docs/WWW,
grothoff <=