Author: grothoff Date: 2005-05-06 04:57:31 -0700 (Fri, 06 May 2005) New Revision: 746
Removed: GNUnet-docs/WWW/gnu.org/index.php Log: del Deleted: GNUnet-docs/WWW/gnu.org/index.php =================================================================== --- GNUnet-docs/WWW/gnu.org/index.php 2005-05-06 11:53:55 UTC (rev 745) +++ GNUnet-docs/WWW/gnu.org/index.php 2005-05-06 11:57:31 UTC (rev 746) @@ -1,199 +0,0 @@ -<?php -include("i18nhtml.inc"); -DOCTYPE("HTML", "Transitional"); -echo "<html><head>\n"; -if ($title) { - echo "<title>"; - TRANSLATE("Doodle: find information on your computer"); - echo "</title>"; - } -if ($description) { - echo "<meta name=\"description\" content=\""; - TRANSLATE("A tool to index and search the files on your disk."); - echo "\">"; - } -echo "<meta name=\"content-language\" content=\"" . - $languagecodes[$lang] . "\">"; -echo "<meta name=\"language\" content=\"" . - $languagecodes[$lang] . "\">"; -?> -<meta name="author" content="Christian Grothoff"> -<meta name="keywords" content="doodle,desktop,search,suffix,tree,meta,data,libextractor,keywords,fam,index,database,free,Linux,GNU,GPL"> -<meta name="robots" content="index,follow"> -<meta name="revisit-after" content="28 days"> -<meta name="publisher" content="Christian Grothoff"> -<meta name="date" content="2004-12-31"> -<meta name="rights" content="(C) 2004 by Christian Grothoff>"; -<meta http-equiv="expires" content="43200"> -<meta http-equiv="content-type" content="text/html"> -</head> -<body> -<?php -generateLanguageBar(); - -H1("Doodle"); -ANCHOR("about"); -H2("About"); - -W("Doodle is a tool to quickly search the documents on a computer."); -W("Doodle builds an index using meta-data contained in the documents and allows fast searches on the resulting database."); -W("Doodle uses %s to support obtaining meta-data from various file-formats.", - extlink_("/libextractor/","libextractor")); -W("The database used by doodle is a %s, resulting in fast lookups.", - extlink_("http://www.nist.gov/dads/HTML/suffixtree.html","suffix tree")); -W("Doodle supports approximate searches."); -BR(); -W("Features that Doodle does not have at the moment include:"); -echo "<ul>"; -LI("A web interface"); -LI("Ordering of search results"); -LI("Spidering (indexing the Internet or websites)"); -echo "</ul>"; -W("If you need these features, have a look at the %s section.", - extlink_("#links", "links")); - -P(); -W("Doodle is licensed under the %s.", - extlink_("http://www.gnu.org/licenses/gpl.html","GNU GPL")); -W("Indexing large volumes can take several hundred MBs of memory (depending on the amount of meta-data found)."); -W("Searching should nevertheless require almost no memory."); -W("Using the latest version of libextractor is recommended."); -W("Doodle has so far only been tested under %s and %s %s %s.", - ARRAY(extlink_("http://www.debian.org/", "Debian"), - extlink_("http://www.redhat.com/", "RedHat"), - extlink_("http://www.gnu.org/", "GNU"), - extlink_("http://www.linux.org/", "Linux"))); -W("Doodle is expected it to work under any platform supported by %s.", - extlink_("/libextractor/", "libextractor")); -P(); - -ANCHOR("download"); -H2("Download"); -W("You can find the current release %s.", - extlink_("download/doodle-0.6.2.tar.gz", "here")); -W("Man-pages for %s, %s and %s are also on-line.", - ARRAY(extlink_("man/doodle.html", "doodle"), - extlink_("man/doodled.html", "doodled"), - extlink_("man/libdoodle", "libdoodle"))); - -W("The latest version can be obtained using"); -PRE("$ svn checkout https://gnunet.org/svn/doodle/"); -P(); -W("If you want to be notified about updates, subscribe to %s", - extlink_("http://freshmeat.net/projects/doodle/", "doodle on freshmeat")); -P(); -W("Debian packages provided by Daniel Baumann can be found %s.", - extlink_("http://packages.debian.org/doodle", "here")); -W("RedHat/Fedora RPM packages provided by Dag Wieers can be found %s.", - extlink_("http://dag.wieers.com/packages/doodle/","here")); -P(); - -ANCHOR("using"); -H2("Using doodle"); -W("First the doodle database needs to be created."); -W("The simplest way to create the database is to run doodle with the <tt>-b</tt> option on the directories that are to be indexed."); -W("For example:"); -PRE("$ doodle -b $HOME"); -W("This will create the doodle database under <tt>~/.doodle</tt>."); -BR(); -W("After creating the doodle database, you can search it."); -W("For example:"); -PRE("$ doodle keyword"); -BR(); -H3("Keeping the database up-to-date"); -W("If you want to keep your doodle database up-to-date, you can either periodically re-run doodle with the <tt>-b</tt> option, or you can use doodled, the doodle daemon."); -W("doodled uses %s to notice whenever a file is changed and instantly updates the doodle database.", - "fam"); -W("In order to use doodled, you must have famd running."); -W("If famd is running, you can start doodled by passing the same arguments that you would pass to doodle to construct the database, but without the <tt>-b</tt> option:"); -PRE("$ doodled $HOME"); -W("You can also use doodled to construct the initial database."); -W("While doodled is updating the database, any doodle search will block until the update is complete."); -W("Note that while you may want to index your entire disk (i.e., <tt>doodle -b /</tt>), it is typically not a great idea to have doodled monitor your entire system for changes -- especially since <tt>/usr</tt> is unlikely to change frequently."); -W("You can address this issue by first indexing <tt>/</tt> and then using doodled to monitor only directories that change frequently:"); -PRE("$ doodle -b /\n" . - "$ doodled $HOME"); -W("This way, your entire system will be in the index, and your home directory will be always up-to-date."); -P(); -H3("Full-text search"); -W("You can achieve a (limited) form of full-text search with doodle."); -W("For that, the dictionary-based plaintext extractors from %s are used.", - extlink_("/libextractor/","libextractor")); -W("In order to use them, you need to pass the option <tt>-b LANG</tt> to doodle."); -W("LANG is a two letter language code that selects the dictionary."); -W("Available languages at the moment are en, es, fr, it and no."); -W("Words and sentences that are available in the respective dictionaries for these languages will then be added to the index."); -W("While libextractor attempts to avoid full-text extraction for certain kown binary formats, it may still find words in non-text files."); -W("Running with this option will dramatically increase the size of the index and the time it takes to build the index."); -W("Note that if you change the options used to build a database will not (!) result in doodle re-indexing files that were processed with other options previously."); -W("The only way to force doodle to re-index files with different options is to either touch the files (change modification timestamp) or to delete the old database and start from scratch."); - -P(); -H3("Hints for system administrators"); -W("If you are the system administrator, you might want to run doodle on the entire system periodically (cron job) and have doodled monitor the home directories in the background."); -W("In that case, it is suggested to have the doodle database be group-readable for a group doodle."); -W("Set the permissions for the doodle binary to SGID to allow users to poll the database."); -W("Doodle will ensure that information about files not accessible to the user are not leaked by checking if files found in the database are accessible to the user."); -W("doodled has to run as root since otherwise it would be impossible to index the personal files of all users."); -W("If that it too risky, doodled will still work, but only index the files readable to the user that runs doodled."); - - -P(); -H3("Using different options for different directories"); -W("You can build a database from multiple doodle runs over distinct sets of files with different options."); -W("For example, the following can make sense:"); -PRE("$ doodle -B en -b /usr/share/doc # full-text index over documentation\n" . - "$ doodle -b /usr /opt /bin /lib # normal index over other system files\n" . - "$ doodled -B en /home # monitor /home, with full-text support\n"); -W("A simple doodle search will then find files in all listed directories."); -W("You can also build multiple disjoint databases and search all of them in one run (see %s for option <tt>-d</tt>).", - extlink_("man/doodle.html", "doodle")); - -P(); -ANCHOR("mantis"); -H2("Bugtrack"); -W("Doodle uses Mantis for bugtracking."); -W("Visit %s to report bugs.", - extlink_("https://gnunet.org/mantis/","https://gnunet.org/mantis/")); -W("You need to sign up for a reporter account."); -W("Please make sure you report bugs under <strong>Doodle</strong> and not under any of the other projects."); -P(); -W("If you dislike Mantis and need to report a bug contact %s via e-mail.", - extlink_("mailto:[EMAIL PROTECTED]","[EMAIL PROTECTED]")); - - -ANCHOR("links"); -H2("Links"); -echo "<ul>"; -LILI("http://members.cox.net/sinzui/medusa/", - "Medusa, similar project for Gnome"); -LILI("http://swish-e.org/", - "Swish-e, indexing tool with focus on the WWW"); -LILI("http://www.gnome.org/~seth/storage/", - "GNOME Storage"); -LILI("http://www.gnome.org/projects/beagle/", - "Beagle"); -LILI("http://sourceforge.net/projects/rlocate/", - "rlocate, version of locate that is always up-to-date"); -LILI("http://www.htdig.org/", - "HTDig"); -LILI("http://jakarta.apache.org/lucene/", - "Lucene"); -LILI("http://homepage.mac.com/pauljlucas/software/swish/", - "Swish++"); -LILI("http://webglimpse.net/", - "Glimpse"); -LILI("http://evidence.sf.net/", - "Evidence, file-manager with support for doodle"); -LILI("http://www.linux-magazin.de/Artikel/ausgabe/2004/09/bgw/bgw.html", - "Article about doodle (and other things) in the German Linux-Magazin"); -echo "</ul>"; -HR(); -echo "<address><a href=\"mailto:[EMAIL PROTECTED]">Christian Grothoff</a></address>"; -PRE("Copyright (C) 2004 Christian Grothoff.\n" . - "Verbatim copying and distribution of this entire article\n" . - "is permitted in any medium, provided this notice is preserved."); -BR(); -generateFooter(); -echo "</body></html>\n"; -?> _______________________________________________ GNUnet-SVN mailing list GNUnet-SVN@gnu.org http://lists.gnu.org/mailman/listinfo/gnunet-svn