This is the readme file for the PC version of WordNet 1.5.  The PC
package contains binaries for MS-DOS and Microsoft Windows interfaces,
the WordNet database, and documentation.  Once installed, the package
takes up approximately 19MB of disk space.  To install WordNet, you
need at least 26MB of disk space.  

You can obtain WordNet either via ftp or on diskette.  Installation
instructions follow for both forms of distribution.  If you receive
WordNet via ftp, please send email to wordnet@princeton.edu to
register yourself in the user database, noting that you are using the
PC version.  Registered users are informed of updates and bugs.  All
other correspondence should also be sent to this email address.

The default installation directory is <H>:\WORDNET, where <H> is your hard
drive, usually C.

NOTE: If you are upgrading from WordNet 1.4, you should move the
contents of the C:\WORDNET directory to some other location if you
wish to preserve version 1.4.  Version 1.5 is organized into
subdirectories - the standard installation procedure places them under
C:\WORDNET (version 1.4 did not use subdirectories).


--- To obtain and install wordnet via FTP ---

STEP 1 

Create the directory <H>:\WORDNET using the 'mkdir' command (where <H> is
your hard drive).  Move into the directory using the 'cd' command.

STEP 2

Use FTP client software (eg. NCSA Telnet) to download the following
files (IMPORTANT - remember to FTP in BINARY mode):

	wn15.zip        (required)
	pkunzip.exe     (needed if you do not have pkunzip on your system)
	wn15si.zip      (optional sense index file - 
			 additional 5.6 MB file, see "Sense Index" below)

These files must be in the <H>:\WORDNET directory that you just created.
	
STEP 3

To install the WordNet package, use the command:

	pkunzip -d wn15.zip

To install the sense index package, first move into the database
directory, <H>:\WORDNET\DICT (where <H> is your hard drive), then use the
command:

	pkunzip -d wn15si.zip


--- To install WordNet from diskette ---

STEP 1

You should begin the installation by setting your current drive to
the hard drive.  Insert Disk 1 into your floppy drive, and type:

<F>:wnsetup <F>: <H>:

where <F> is the drive containing the diskette, and <H> is your hard
drive, usually C.  This will copy the installation program WNINST.BAT
into the DOS directory of the hard drive specified as <H>.

STEP 2

Leave Disk 1 in your floppy drive.

Type:
wninst <F>: <H>:

where <F> is the drive containing the diskette, and <H> is your hard
drive, usually C.  WNINST will create the target directory <H>:\WORDNET,
and will install the package.  Swap diskettes as instructed.

STEP 3 (optional installation of sense index)

Copy the contents of both Sense Index diskettes into the the directory
in which the WordNet database is installed (the default is
C:\WORDNET\DICT).  Type:

siinst

--- After the installation ---

The DOS version of WordNet contains two interfaces to the WordNet
database.  WNDOS.EXE is a command line interface and WNWIN.EXE is a
Microsoft Windows interface.  WNDOS is generally accessed via WN.BAT
which runs WNDOS and pipes the output through 'more'.

The correct installation of WordNet results in the following
subdirectories being created in the <H>:\WORDNET directory (where <H> is
your hard drive):

	<H>:\WORDNET\BIN - executable programs
		wn.bat
		wndos.exe
		wnwin.exe

	<H>:\WORDNET\DICT - WordNet database files
		*.exc           (noun, verb, adj, adv, cousin)
		*.dat           (noun, verb, adj, adv)
		*.idx           (noun, verb, adj, adv)
		cousin.tps
		vframes.txt     
		cntlist         
		lexnames        

	<H>:\WORDNET\MAN - WordNet documentation
		*.txt 
		*.ps

--- Informing DOS of the new program ---

The WordNet interfaces expect the database files to be installed in
the directory C:\WORDNET\DICT by default.  If you have NOT installed
the database files here, you must put the following line into your
"autoexec.bat" file:

set WNSEARCHDIR=<H>:\DIRECTORY

where <H> is your hard drive and DIRECTORY is the directory in which the
WordNet database files have been installed.

DOS also needs to know where the executable programs reside.  You
must add the path to the PATH environment variable in your
"autoexec.bat" file.  You should add the following to the end of your
"autoexec.bat" file:

PATH %PATH%;<H>:\DIRECTORY

where <H> is your hard drive and DIRECTORY is the directory in which the
WordNet interface programs have been installed.  If you have used the
installation program provided, DIRECTORY will be WORDNET\BIN.

You should reboot (or type "autoexec") after making these changes so
that DOS will be informed of the changes.

--- Informing Windows of the new program ---

If you use Microsoft Windows, you may also wish to place the WNWIN
icon in the Program Manager so you can use WordNet simply by
double-clicking on the icon.  This is done by selecting "New" from the
Program Manager file menu.  Then select "New Program Item" from the
dialog box, and press OK.  Type in the full pathname of the program:

<H>:\DIRECTORY\WNWIN.EXE

in the box labeled "Command Line", where <H> and DIRECTORY are as
described above (default location is C:\WORDNET\BIN).  For more
information on the Program Manager and Program Items, refer to your
Microsoft Windows documentation.

--- Hints for using the command line interface ---

Entering WNDOS with no arguments will print out a usage statement
listing the valid options.  The command "WNDOS search_word" prints a
list of the searches that are available for the word in all the parts
of speech.  

If you use WN, all output is piped through 'more'.  The WNDOS command
is useful if you want to redirect search results to a file.  For
example: 

WNDOS search_word search_type > SEARCH.OUT

performs the desired search on the search word, writing the results to
SEARCH.OUT, rather than the terminal.  To search for a collocation,
either enclose the search string in double quotes or connect the
individual words with underscore characters.  

Please read the document "wn.txt" for more information on the command
line interface.

--- The Sense Index ---

New with version 1.5 is the "sense index".  The sense index provides
an alternate method for accessing synsets in the WordNet database.  A
specific WordNet sense can be used to directly index into this file
and obtain the WordNet sense number and synset address for the sense.
The sense index file is 5.6MB, and is not used by the WordNet
interfaces.  Due to its size, and the fact that it is not needed by
the package, it is not included in the PC package.  It can be obtained
and installed via FTP as described earlier.  It is also distributed on
diskette for an additional $10 charge.  Please send a check, payable
in US currency, to Princeton University at the address below:

	Pamela Wakefield
	Department of Psychology
	Green Hall
	Princeton University
	Princeton, NJ 08544-1010
	Attn: WordNet