ProfitPress Mega CDROM2 …eeware (MSDOS)(1992)(Eng)/ProfitPress-MegaCDROM2.B6I/TEXT/UTILITY/PCKIM386.ZIP/README.DOC

Text File | 1992-01-20 | 16.0 KB | 357 lines

README.DOC as of 20-Jan-92

PC-KIMMO Version 1.0.7 for IBM PC, 26-Dec-91
Beta version for 386 CPU under MS-DOS (VCPI compliant)

*************************************************************************
NOTE: This version of PC-KIMMO will ONLY work on a PC-compatible that
has a 386 CPU. It will use all available extended/expanded memory. If you
do not have such a computer, use the plain version of PC-KIMMO.

The main use of this 386 version is to run Englex, a large English lexicon.
It should be available from the same source as PC-KIMMO.

This program was compiled with DJ's GCC port to DOS. If you want source
code files for PC-KIMMO, write to me.
*************************************************************************

This is the program that accompanies the book "PC-KIMMO: a two-level
processor for morphological analysis" by Evan L. Antworth, published by the
Summer Institute of Linguistics (1990).  The book with diskette(s) is
available for $23.00 (plus shipping) from:

    International Academic Bookstore
    7500 W. Camp Wisdom Road
    Dallas TX, 75236
    phone: [phone]

The PC-KIMMO executable program and the source code library are copyrighted
by the Summer Institute of Linguistics but are made freely available to the
general public under the condition that they not be resold or used for
commercial purposes.

The developers of this software can be reached at the following address:

    Academic Computing Department
    7500 W. Camp Wisdom Road
    Dallas, TX  75236
    phone: [phone]
    internet: [e-mail]

PC-KIMMO update history:
        Version 1.0,    6 Feb 90     first release
        Version 1.0A,  14 Jul 90     fixed a portability bug
        Version 1.0B,   6 Sep 90     fixed a generator bug and a recognizer bug
        Version 1.0.3, 15 Sep 90     fixed a bug related to insertions
        Version 1.0.5, 26 Feb 91     fixed problem loading large lexicon,
                                     fixed bug in Mac version that caused
                                     certain warning messages to crash the
                                     system
        Version 1.0.6, 19 Nov 91     fixed memory leak
                                     fixed problem printing dots in Mac version
        Version 1.0.7, 26 Dec 91     386 version

The contents of the remainder of this file are as follow:

    1 VERSIONS AVAILABLE
    2 [deleted]
    3 INSTALLING PC-KIMMO
    4 SETTING THE PATH VARIABLE
    5 SETTING THE EDITOR VARIABLE
    6 STARTING PC-KIMMO
    7 ENTERING COMMANDS AND GETTING ON-LINE HELP
    8 DEFAULT FILE NAMES AND EXTENSIONS
    9 LEARNING PC-KIMMO
    10 CONTENTS OF THE RELEASE DISKETTE
    11 ERRATA
    12 BUGS

1 VERSIONS AVAILABLE

PC-KIMMO is available for three operating systems:
    MS-DOS or PC-DOS (any IBM PC compatible)
    UNIX System V (SCO UNIX V/386 and A/UX) and 4.2 BSD UNIX
    Macintosh

There are two versions of the PC-KIMMO release software, one for IBM PC
compatibles and one for the Macintosh. The release software is supplied
either on two 5.25" diskettes or on one 3.5" diskette. For those who wish
to compile PC-KIMMO for their UNIX system, the complete source code is
available for the cost of the media and shipping. Contact either the
International Academic Bookstore or the Academic Computing Department
at the addresses above.


3 INSTALLING PC-KIMMO

Before proceeding further with PC-KIMMO, you must properly install it.

    1. To install PC-KIMMO on a hard disk, use the INSTALL.BAT
    procedure supplied with the release software to install the
    system on your hard disk. To do this, insert the PC-KIMMO
    diskette (diskette #1, if the software is on two diskettes) in
    one of your disk drives. Type A: (or whatever the name of the
    drive is) in order to log control to that disk. Now type INSTALL
    followed by the name of the hard disk on which you want to
    install PC-KIMMO (for instance, INSTALL C:). This will create on
    drive C a subdirectory called and will copy the contents of the
    release diskette (with all its subdirectories) into it.

    2. To install PC-KIMMO on a floppy disk system, make a
    working copy of the release software by copying the entire
    diskette to another diskette, including subdirectories and all of
    their files (if the software is on two diskettes, copy both). The
    easiest way to do this is to use the DOS utility program XCOPY.
    Place a diskette (probably your DOS utilities diskette) that
    contains XCOPY in drive A, place a blank working diskette in
    drive B, and enter this command:

        xcopy a:*.* b: /s /v /w

    You will see the message "Press any key to begin copying file(s)".
    Now take the diskette out of drive A, put in the PC-KIMMO release
    diskette, and press any key. If the release software is on two
    diskettes, repeat this procedure with the second diskette.

4 SETTING THE PATH VARIABLE

Whether you are using a floppy or hard disk system, the operating system's
PATH variable must be set to include the directory where the PC-KIMMO
program is found. The AUTOEXEC.BAT file on your boot disk should contain a
path statement that specifies all the disks and directories that contain
programs. On a floppy disk system, the path statement should include as a
minimum the root directory of drive A, for instance, PATH=A:\. On a hard
disk system, add ;C:\PCKIMMO to the end of the path statement. For the path
statement to become effective, you must reboot the computer. (If you want
to change the path variable without changing the AUTOEXEC.BAT file and
rebooting, enter a path command directly at the operating system prompt.)

5 SETTING THE EDITOR VARIABLE

In order to use PC-KIMMO's EDIT command, you must set the operating system
environment variable EDITOR to the name of your text editing program. This
is done by including in the AUTOEXEC.BAT file a line of this form:

    SET EDITOR=<filespec>

where <filespec> specifies the path and full file name of your editing
program. For example, if your editor's file name is EMACS.EXE and is found
in the UTIL subdirectory directly under the root directory, include this
line:

    SET EDITOR=\UTIL\EMACS.EXE

6 STARTING PC-KIMMO

Be sure that DOS is logged onto the drive where PC-KIMMO is located. To
change to the subdirectory that contains the English example, enter CD
\ENGLISH on a floppy disk system, or CD \PCKIMMO\ENGLISH on a hard disk
system. Now type PCKIMMO (if your PATH variable is not correctly set to
include the PC-KIMMO subdirectory, type ..\PCKIMMO). When PC-KIMMO has
successfully started up, you will see a version message and the PC-KIMMO
command line prompt.

PC-KIMMO can also be started with optional command line arguments. The
format of the command line is:

    pckimmo [-c  <char>] [-r  <rulefile>] [-l  <lexfile>] [-t <cmdfile>]

The options are used as follows:

    The -c option changes the character used to delimit
    comments in files used by PC-KIMMO. The argument <char> is a
    single character. If this option is not specified, the semicolon
    (;) will be used as the comment delimiter. This option is
    equivalent to issuing the SET COMMENT command from the program
    prompt.

    The -r option specifies a rules file to be loaded. It is
    equivalent to issuing the LOAD RULES command from the program
    prompt.

    The -l option specifies a lexicon file to be loaded. It is
    equivalent to issuing the LOAD LEXICON command from the program
    prompt. It must be used with the -r option.

    The -t option specifies a command file from which PC-KIMMO
    reads and executes commands. It is equivalent to issuing the TAKE
    command from the program prompt.

7 ENTERING COMMANDS AND GETTING ON-LINE HELP

The user interacts with PC-KIMMO by entering commands at the command line
prompt, in much the same way that one enters commands at the operating
system prompt. Case is ignored for all command keywords. Keywords can be
shortened to any unambiguous form. For instance, LOAD RULES, LOAD RUL, LOAD
R, and LOA R are all acceptable. Typing just L is ambiguous for the
commands LOAD, LOG, and LIST. However, because LOAD is such a frequently
used command, it takes special precedence over the other commands beginning
with L, which means that typing just L will execute only the LOAD command.

PC-KIMMO can be used with a TSR (Terminate and Stay Resident) command line
editor such as CED or NDOSEDIT. This allows the user to recall and edit
several previous command lines. The list of previous PC-KIMMO command lines
is kept separate from the list of previous operating system command lines.
If you exit PC-KIMMO and then run it again, the set of command lines from
your previous PC-KIMMO session is still available. Neither of the command
line editors remembers a command shorter than three characters. It should
be noted that CED uses the ^ character as a kind of "virtual carriage
return." This means that forms containing ^ as an alphabetic character
cannot be entered from the keyboard with the GENERATE and RECOGNIZE
commands, though of course such words can be read from a file.

Screen scrolling can be halted by pressing Ctrl-S (that is, hold down the
Ctrl (Control) key and press S); any key will resume scrolling.

Processing can be interrupted by pressing Ctrl-C. Note that this action
does not abort PC-KIMMO, but returns it to the program prompt. It is useful
for stopping a long screen display (such as a trace) or a file processing
command.

Pressing Ctrl-P causes screen output to be echoed to the printer. Pressing
Ctrl-P again stops printer echoing.

There are several ways to get on-line help:

    To get a list of the available commands, type ?.

    To get information on what these commands do, type HELP.

    To get the specific syntax and use for a command, type HELP
    plus a specific command name.

    To get a list of the keywords that can go with a particular
    command, type the command name followed by ?. Note however that
    if the command does not take a keyword it will be executed; for
    instance typing NEW ? will execute the NEW command.

8 DEFAULT FILE NAMES AND EXTENSIONS

The display below summarizes the default file names and extensions assumed
by PC-KIMMO. Two entries are given for the different kinds of files. The
first is the name PC-KIMMO will assume if no file name at all is given to a
command that expects that kind of file. The second entry (with the *) shows
what extension PC-KIMMO will add if a file name without an extension is
given.

    Rules file:                     RULES.RUL
                                        *.RUL
    Lexicon file:                 LEXICON.LEX
                                        *.LEX
    Generation comparison file:      DATA.GEN
                                        *.GEN
    Recognition comparison file:     DATA.REC
                                        *.REC
    Pairs comparison file:           DATA.PAI
                                        *.PAI
    Take file:                    PCKIMMO.TAK
                                        *.TAK
    Log file:                     PCKIMMO.LOG

9 LEARNING PC-KIMMO

You are now ready to try out PC-KIMMO. Chapter 2 of the book will guide you
through a sample user session with PC-KIMMO. To learn how to develop your
own language descriptions using PC-KIMMO you must work through the tutorial
found in chapters 3 through 6 of the book. A general introduction to
PC-KIMMO is found in chapter 1. A concise reference manual of the PC-KIMMO
program is found in chapter 7. Appendix A also shows how a description of
English was developed. Appendix B demonstrates other uses of PC-KIMMO's
two-level processor. Appendix C documents the PC-KIMMO function library and
shows how to write C programs that use it.

10 CONTENTS OF THE RELEASE DISKETTE

This diskette contains the following files in the top-level directory:

    DEMO     BAT      batch file to run short demo
    INSTALL  BAT      batch file to install PC-KIMMO
    GETYN    COM      utility program for batch file
    README   DOC      this file
    ERRATA   DOC      errors in book
    UPDATE   DOC      program revision history
    BUGS     DOC      known program bugs
    REGISTER DOC      registration form
    PCKIMMO  EXE      executable PC-KIMMO program
    LEXICON  LEX      lexicon file template
    RULES    RUL      rules file template
    PCKIMMO  TAK      sample TAKE file

This diskette also contains the following subdirectories, each of which
contains sample PC-KIMMO applications.  (Note that if your PC-KIMMO
software is on two diskettes some of these subdirectories will be located
on the second diskette. You can use the INSTALL2 program on the second
diskette to copy the files to the PCKIMMO subdirectory on your hard disk.)

Each subdirectory contains a TAKE file that will run an automatic
demonstration of the sample.  For example, if you open the CVCV
subdirectory and enter "pc-kimmo -t cvcv", you will see a demonstration of
the phonotactic analyzer. When the demonstration is over, you will be left
at the PC-KIMMO program prompt. To get on-line help for running PC-KIMMO,
type HELP and follow the instructions. When you are finished experimenting
with the sample application, type QUIT or EXIT to leave PC-KIMMO and return
to the operating system.

    CVCV              phonotactic analyzer from appendix B
    ENGLISH           English description from appendix A
    FINNISH           Finnish description
    HEBREW            Hebrew description
    JAPANESE          Japanese description
    KASEM             Kasem description
    LOGIC             logic problem from appendix B
    MENDE             Mende description
    MINLEX            minimal lexicon from appendix B
    PROTO             sound change example from appendix B
    SAMPLE            sample files from chap. 3
    SAMPLER           example rules from chap. 6
    SOUNDEX           two-level implementation of the Soundex method (29-Oct-90)
    TAGALOG           Tagalog description
    TURKISH           Turkish description
    ZOQUE             Zoque description

The following subdirectory contains files of source code that constitute
the PC-KIMMO function library. These files as well as two sample programs
that use the function library are described in appendix C of the PC-KIMMO
book.

    PCKLIB            function library (see appendix C)

11 ERRATA

Errors in "PC-KIMMO: A Two-level Processor for Morphological Analysis"
   discovered as of February 6, 1991

1. The generator algorithm on pages 198-199 (section 7.9.1) is slightly
   misleading.  Step 3 (testing all feasible pairs containing a NULL
   lexical character, and recursively invoking the algorithm for each
   pair that successfully steps the automata) should be carried out even
   when the lexical form is empty.  In other words, Step 3 actually takes
   place before Step 1.

   This reflects a bug in the implementation that was partially fixed in
   version 1.0B, and fully fixed in version 1.0.3 of PC-KIMMO.

2. The reference to natural phonology  on the top of page 7 should be
    changed to natural generative phonology (Hooper 1976).

3. Table 41 on page 69:  the 1 in state 3 of the m:m column should be
   a 2 (see the partially written version of the same table just above).

4. Table 45 on page 72: the 1 in state 3 of the s:z column should be
   a 0 (zero).  It should be pointed out that while the s:z column of table
   44 (a <= rule) is filled in with ones, but the s:z column of table 45
   (a <=> rule) must be filled in with zeros, since s:z must be prohibited
   from occurring in any environment except V___V.

5. Table 53a on page77: the 1 in state 3 of the i:i column should be a 2.

6. Table 54a on page 78: the 1's in state 3 of the u:u column and the o:o
   column should both be 2's.


12 BUGS

1.  In the Macintosh version, pressing Command-. (clover-leaf key plus
period) to abort a command that is reading or writing a disk file may leave
the file open.  Not sure if Control-C on MS-DOS also does this.