File: README

package info (click to toggle)
wordinspect 0.1a-6
  • links: PTS
  • area: main
  • in suites: potato
  • size: 384 kB
  • ctags: 133
  • sloc: ansic: 1,771; sh: 311; makefile: 142
file content (164 lines) | stat: -rw-r--r-- 6,723 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
Word Inspector (wordinspect 0.1)

Copyright (c) 1998 Scott W. Gifford <sgifford@tir.com>


====================================================================
Word Inspector is a graphical front-end to the "dict" program.  The
dict program allows you to search through one or more dictionary-like
reference books for a word, then displays its definition.  Word
Inspector expands that by allowing you to enter words to look up more
easily, easily look up words that appear in the definition for another
word, and automatically look up a word in the X Windows selection.

It was written by Scott Gifford.

Word Inspector uses the GTK+ library (http://www.gtk.org/) for its
user interface, and was built with the Glade interface builder
(http://www.comp.lancs.ac.uk/~damon/builder/index.html).
====================================================================


Getting it
====================================================================
You can download the latest version of Word Inspector from its
homepage, at:

     http://www.tir.com/~sgifford/wordinspect/
====================================================================


Release Notes
====================================================================
See the file NEWS, included with this distribution.
====================================================================

Requirements
====================================================================
GTK 1.0.0 or greater (http://www.gtk.org/).  Note that Word Inspector
was written and tested with GTK 1.0.5; it may or may not work
correctly with other versions.  GTK 1.0.5 contains numerous bugfixes
and improvements, so you should probably download it and install
it anyways.

A copy of the dictd distribution (http://www.dict.org/).
Tested with version 1.4.9.

The address of a dictionary server.  Dict, and therefore Word
Inspector, requires a dictionary server.  You can use one of several
available for use on the Internet (documented in the dictd
distribution), or run your own (which is fairly easy, and allows you
to use your dictionary when you are not connected to the Internet).
This is included in the dictd distribution.

A reasonable compiler and C library.

Tested on RedHat Linux 5.0.
====================================================================


Using it
====================================================================
Please install a copy of dict (see above) and make sure it works and
is in installed in your path before installing Word Inspector.

Once you have done that, you should be able to install Word Inspector
it with the usual

     ./configure
     make
     make install

described (generically) in INSTALL.  You may get a couple warnings
about unused functions; these are left over from the beta version of
Glade I used to develop.

Most configuration of Word Inspector is currently done by configuring
dict.  See the documentation accompanying that package for more
information.  I hope to include a GUI configuration tool in a future
version.

If you're not the reading type, at this point you can run

     wordinspect

to see the GUI (try button 3), and

     wordinspect --help

to see what command-line options you have, then skip to the end of
this section to see some interesting things you can do.

Once you have installed it (presumably into your PATH), you can run it
by typing "wordinspect."  Of course, you may find it more convenient
to add it to your X Windows menu (or however you like to launch
programs).  This will bring up a the "Word Finder" window, which
allows you to enter a word to look up.  Simply enter the word you want
to look up, and hit Enter or the "Search" button.  Word Inspector will
pause while it looks up the word, then pop up a new window with the
definition if it could find it, or some suggestions if it couldn't.
If it can't find anything that even resembles the word you entered, it
will display a window letting you know that, too.

In any Word Inspector window, you can right-click (button 3) on a word
to get a menu of various ways to get more information on that word.
Currently, the two choices are to define the word (look it up
directly), or search for it (pop up a search window with that word
entered in it).  If you want to look up a multi-word phrase, select
the phrase with the button 1, as if you were going to paste it into
another window, then right-click on the selection to see the same menu
for the entire phrase.  Spaces, newlines, and punctuation are
automatically removed from your selection, to help dict find it.

Of course, you can copy any information you'd like from the Word
Inspector window for pasting into other applications.  Like in most X
applications, hilighting the words with the button 1 makes it the
primary selection, and you don't have to hit anything to paste it into
another application.

When you are finished reading the definition for a word, click on the
"OK" button at the bottom to get rid of the window.  If you searched
for a word, you can search for another one by just replacing the word
you typed and hitting Enter or Search again.  Word Inspector won't
exit until you have closed all of its windows, so you can close
anything (including Word Finder windows) at any time.

You can also pass various options to wordinspect on the command-line.
A few useful ones are:

     --help: Display all options available for wordinspect.
     --version: Display wordinspect's current version and copyright.
     --search: Search for the word provided on the command line 
               [Default].
     --define: Define the word provided on the command line.
     --clipboard: Use the word currently in X's primary selection (the
                  clipboard) as if it were typed on the command line.
                  Useful for launching from a menu or hot-key.
     --dict=/path/to/dict: Use the copy of dict in /path/to/dict.

My favorite way to use Word Inspector is to include a menu item on my
WindowMaker desktop that runs:

     wordinspect --define --clipboard

, one for

     wordinspect --search --clipboard

, and one that just runs

     wordinspect

.  This lets me hilight a word in Netscape, an xterm, Emacs, or any
other application, and then just click on my desktop menu to look it
up.  If I could figure out how to get hotkeys to work, that would be
even cooler . . . :-)
====================================================================


Copyright
====================================================================
Word Inspector is copyrighted by Scott Gifford and is licensed through 
the GNU General Public License. Read the COPYING file for the complete
license.
====================================================================