packages icon
README for xdict version 1.0.2 (build1199/static)
Zurich/Switzerland, November 17, 1999

A scientific fuzzylogic algorithm implementation
xdict is copyright (c) 1999 by Marc O. Gloor



Installation (quick setup)
==========================

Run './install.sh' as root. 



Installation (manually)
=======================

  1.  Login as root
  2   Create a new folder /usr/local/xdict
  3.  Move xdict.bin to /usr/local/bin
  4.  Move xdict.dat to /usr/local/xdict/
  5.  Move all other files (Source) to /usr/local/xdict
  6.  Move xdict.1 to /usr/man (or read manpage with 'man -l xdict.1')
  7.  Logout (exit) from root, login as normal user
  8.  Run xdict with the command 'xdict.bin -d /usr/local/xdict/xdict.dat'



Using Xdict
===========

Xdict is running under X11, even so there are 3 commandline
options (arguments) available:

 syntax: xdict.bin [arg1] [arg2]
 usage : xdict.bin -h -v -d dictfile
 
 arguments are:
  -h       show help
  -v       show version
  -d file  location of database (xdict.dat)

 example: xdict.bin -d /home/johnson/xdict.dat
 
Running xdict without options will use xdict.dat in the
same directory as the binary is, otherwise an error message
occured.



Xdict Packages / Content
========================

There are currently 4 Unix packages available:

 xdict-1_0_2.tar.gz                  -->  Includes both packages below
 xdict-1_0_2_i386_ELF_statbin.tar.gz -->  Statically linked binary (Linux)
 xdict-1_0_2_src.tar.gz              -->  Sourcecode (C/Gtk-API)
 xdict-src.zip                       -->  Zip file for Windows...
  
Contents:
 
 COPYING      -->  General Public License, Version 2
 README       -->  README File for xdict (this file)
 install.sh   -->  Installation shellscript (run as root)
 xdict.bin    -->  Xdict binary (statically or dinamically)
 xdict.dat    -->  Xdict database english/german
 build.sh     -->  Compiler Shellscript
 xdict.c      -->  Xdict Sourcecode (C/Gtk+)
 xdict.h      -->  Xdict Headerfile
 xdict.gld    -->  Xdict GUI (Glade)
 xdict.1      -->  Xdict Manpage (/usr/man/man1)
 xdict.ps     -->  Xdict Manpage (Postscript)



About Xdict for Unix
====================

xdict is a graphical dictionary for Unix, written by Marc O. Gloor
<mgloor@acm.org> and distributed under the terms of the GNU General Public
License, Version 2. This software is distributed 'as is', free of charge,
no warranty of suitability or reliability is offered; use this at your own
risk. The author assumes no responsibility for any damages, direct or
incidental, resulting from the use of this software. See file 'COPYING'.
Other distribution terms may be available by explicit request, mail me
for details.

The current release is 1.0.2. This is intended as a stable release.

The latest version of xdict is available at the official Xdict Homepage: 
http://hp.globacom.net/mgloor/xdict.html.

If you have any questions or comments, or if you find a bug, mail me
to <mgloor@acm.org>. Thanks to all the people who wrote with bug reports,
suggestions, comments and criticism. 



What is FuzzyLogic?
===================

Xdict for Unix uses "intelligent" algorithms, nothing like "stupid" plain-
text search routines implemented in many texteditors. 

Scientific fuzzylogic algorithms uses NGramms to compare common letters
in dependence among themselves, see sourcecode of xdict to learn more
about the algorithm.

For example if you search the english word for "Dampfschiff" and you
type "Dampschiff", fuzzyloggic algorithms will find the correct Word
"steamboat" for you. Similar Words like "Dampfschifffahrt" are also
displayed.

If you need the dictionary database - use it. The database
includes more than 130'000 conversions (!) in the file 'xdict.dat'.
Visite also 'ftp.leo.org' for more information about public dicts.

Because xdict use a plaintext database (no SQL or equal), it's a bit
slowly sometimes. A real database implementation is part of the todo
list.



Todo
====

- Contributions and cooperations are welcome!
- Statically linked binary packages (distributions) for:
  AIX, Solaris, SunOS, HP-UX, SGI (and many more...) 
- Debian Package (a package maintainer?)
- SQL Database implementation of the dictionary
- Gnome compatibility
- Italian, French and Spanish Support
- and all what you suggest...



Requirements
============

Xdict build 1199 is statically linked against the gtk+, gdk and glib libs.
The binary is running on every Linux glibc Intel/AMD/Cyrix environment.  



Build
=====

Compile Source against the newest Gtk+ libraries available from www.gtk.org.
The included build-Shellscript (build.sh) will compile a statically binary.
If you compile statically, make sure you link against existing object files
in your path. Build dynamically needs some build script modifications.
Anyway - Do with the source what you want under the terms of the GPL :).



About the Author
================

I'm working as System Engineer at Kuoni Travel Ltd. Headoffice Europe.
Xdict is the result of a rainy week-end in my spare time. You can reach me
via mail <mgloor@acm.org>. Public Key ID is 0x2CDBF3A1 from 17.7.95, the 
RSA Key has following fingerprint: 0944B1900FA0956EDE9C1DA1180330D6.
Visite my web page at http://hp.globacom.net/mgloor.