"Fossies" - the Fresh Open Source Software Archive

Member "edict/README" (2 Mar 2003, 4051 Bytes) of package /linux/privat/old/edict-2.6.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 ##############################################################################
    2 # edict - Your personal command line dictionary
    3 #
    4 # Copyright (c) 2002-2003 Vishal Verma <vermavee@users.sf.net>. 
    5 # All rights reserved.
    6 # 
    7 #    This program is free software; you can redistribute it and/or modify
    8 #    it under the terms of the GNU General Public License as published by
    9 #    the Free Software Foundation; either version 2 of the License, or
   10 #    (at your option) any later version.
   11 #
   12 #    This program is distributed in the hope that it will be useful,
   13 #    but WITHOUT ANY WARRANTY; without even the implied warranty of
   14 #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   15 #    GNU General Public License for more details.
   16 #
   17 #    You should have received a copy of the GNU General Public License
   18 #    along with this program; if not, write to the Free Software
   19 #    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   20 #
   21 ##############################################################################
   22 
   23 
   24 WHAT IS IT?
   25 ===========
   26 
   27 edict is a dictionary program written in PERL. edict can fetch meanings of the 
   28 words you supply to it as arguments. edict is capable of using one of the many
   29 user defined dictionaries to fetch the word meanings.
   30 
   31 -------------- IMPORTANT -----------------
   32 NOTE: Please note that edict uses various dictionary web-sites to fetch the
   33 meanings of the words. Please read the "TERMS OF USE" of the dictionary
   34 site before you start using it. Don't use the program if you intend to violate
   35 the "TERMS OF USE". The author of this program will not be held responsible for 
   36 any violations/consequences in any way. The program is provided just to 
   37 facilitate fetching text using HTTP.
   38 -------------- IMPORTANT -----------------
   39 
   40 INSTALLING EDICT - UNIX
   41 ================
   42 
   43 Just run the following command in the current directory
   44 
   45 make install
   46 
   47 This will install the edict program in the /usr/bin directory most probably. 
   48 Run make without any arguments to verify that. 
   49 
   50 If you want to install edict in a different directory, you can run the above 
   51 command as
   52 
   53 make prefix=/my/dir install
   54 
   55 After that you can remove the edict directory.
   56 
   57 
   58 INSTALLING EDICT - Windows
   59 ================
   60 
   61 Run the following command in the edict directory
   62 
   63 wininstall [<target dir>]
   64 
   65 The <target dir> is optional. If you specify a <target dir>, edict will be 
   66 installed in that very directory. 
   67 
   68 NOTE: The <target dir> should be an absolute path. This means you SHOULD NOT say
   69 
   70 wininstall mydir
   71 
   72 Instead, you should say
   73 
   74 wininstall c:\path\to\mydir
   75 
   76 After installing edict in Windows, you should modify your PATH to include the 
   77 <target dir>. Open the System icon in Control Panel and select the Advanced tab.
   78 Now click on "Environment Variables..." to edit PATH.
   79 
   80 USING EDICT
   81 ===========
   82 
   83 On most UNIX platforms, you can run edict by typing
   84 
   85 edict <word>
   86 
   87 where <word> is the word for which you want to lookup the meaning.  The first line in the edict source file specifies the path of the 
   88 PERL interpretter. If PERL is installed in a path different from /usr/bin, you can change it there.
   89 
   90 On Win32 platforms, you'll have to run edict as
   91 
   92 perl <edict> <word>
   93 
   94 where <edict> is the absolute or relative path of the edict program and <word> is the word you are looking for. So an example run 
   95 can be
   96 
   97 perl c:\bin\edict orotund
   98 
   99 This will display the meaning of the word "orotund" provided you have perl installed on your machine and the file c:\bin\edict exists.
  100 
  101 
  102 Multiple words may be specified as
  103 
  104 edict sexist misogynist dinosaur
  105 t is possible that you don't have a direct connection to Internet and use a proxy-server. In that case you can ask edict to use a 
  106 proxy-server by typing
  107 
  108 edict -p server:port orotund
  109 
  110 If you supply an invalid word to edict as:
  111 
  112 edict junkword
  113 
  114 you'll see the following as error:
  115 
  116 Don't understand Swahili words like junkword! ;)
  117 
  118 Thesaurus support is also available starting version 1.0. Type ethes instead of edict to get thesaurus entries. Rest of the options are same.
  119 
  120 Happy edicting!