This is the software release 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: 214/709-2404
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: 214/709-2418
internet: evan@txsil.lonestar.org
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, 14 Sep 90 fixed a bug in inserting surface chars
The contents of the remainder of this file are as follows:
1 VERSIONS AVAILABLE
2 RUNNING THE DEMO
3 INSTALLATION
4 STARTING MacPC-KIMMO
5 ENTERING COMMANDS AND GETTING ON-LINE HELP
6 PC-KIMMO COMMANDS NOT AVAILABLE IN THE MACINTOSH VERSION
7 ACCESSING FILES IN DIRECTORIES OTHER THAN THE CURRENT ONE
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 diskette, 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 from:
Academic Computing Department
7500 W. Camp Wisdom Road
Dallas, TX 75236
2 RUNNING THE DEMO
To see a very brief demonstration of PC-KIMMO on some English data, run
the MacPC-KIMMO program by double-clicking on it. You will see a dialog
box; just press return and you will be left at the PC-KIMMO program
prompt. Now type "take demo" and press return. This will run a command
file that will load the English rules and lexicon, generate and recognize a
few words, and exit PC-KIMMO.
3 INSTALLATION
Before proceeding further with PC-KIMMO, you should copy the PC-KIMMO
release diskette to your hard disk. Create a new folder named PC-KIMMO
and copy into it all the files and folders from the release diskette.
4 STARTING MacPC-KIMMO
Like other Macintosh programs, just double-click on the MacPC-KIMMO
program icon. You will see a dialog box where you can enter command line
options in the same way as the MS-DOS or UNIX versions of PC-KIMMO
allow. If you do not want to use command line options, press Return. The
dialog box also gives you the opportunity to redirect standard input and
output. For instance, if you send output to both the console and a file, the
file that is created will contain a complete record of your session with
PC-KIMMO. The logging facility in PC-KIMMO is similar, but differs in that
only generation and recognition operations are recorded in the log file.
If you want to start PC-KIMMO using command line options, enter them
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.
5 ENTERING COMMANDS AND GETTING ON-LINE HELP
The Macintosh version of PC-KIMMO has the same command line interface
as the MS-DOS and UNIX versions. The user types commands at the PC-
KIMMO program prompt which PC-KIMMO executes and prints the result on
the screen. 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.
The command line can be edited using the mouse, the arrow keys, and the
Delete key. Also, pressing any of the keys Control-U, Esc, or Clear will
erase the command line. The Macintosh version also enables the user to
copy anything visible on the screen and paste it into the command line.
This is done by using the mouse to highlight material on the screen and
then executing the Copy and Paste commands available either on the Edit
menu or with the Command keys (see your Macintosh documentation).
Here are some other useful operations:
To pause screen scrolling, hold down the mouse button.
To interrupt an operation (such as a long trace display or a file
reading/writing function), press Command-. (that is, hold down the
Command key and press the period key). This is the same as Control-C
with the MS-DOS or UNIX versions.
Entering Control-D from the keyboard signifies end-of-file (control-Z
on MS-DOS, control-D on UNIX).
To exit PC-KIMMO, either press Command-Q or choose Quit from the
File menu. You can also enter either of the PC-KIMMO
commands EXIT or QUIT.
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.
6 PC-KIMMO COMMANDS NOT AVAILABLE IN THE MACINTOSH VERSION
The EDIT command and the SYSTEM command are not available in the
Macintosh version of PC-KIMMO. To edit a file without quitting PC-KIMMO,
either use a desk accessory editor or run PC-KIMMO under MultiFinder so
that you can switch back and forth between PC-KIMMO and your editor.
Remember that after editing a rules file or a lexicon file it must be loaded
again for PC-KIMMO to use the changes. To do operating system functions
such as copying, deleting, or renaming files, run PC-KIMMO under
MultiFinder.
7 ACCESSING FILES IN DIRECTORIES OTHER THAN THE CURRENT ONE
PC-KIMMO considers the directory (folder) where the program file resides
to be the current or default directory. While running PC-KIMMO, it is often
necessary to access files in other directories. The Macintosh version of
PC-KIMMO has a special command for changing directories called CD. Its
command syntax is CD <pathname>, where <pathname> is a concatenation
of volume and directory names. The Macintosh uses the colon as a
separator character between directory names in much the same way that
MS-DOS uses a \ or backslash character. There are two types of
pathnames: full pathnames and partial pathnames. A full pathname starts
with the name of the root directory (or volume name). For example, a full
pathname to the English directory might look like this:
MyDisk:PC-KIMMO:English
A partial pathname starts with the name of a directory whose position in
the directory tree must be specified relative to the current directory. A
partial pathname always starts with a colon (whereas a full pathname
never does). For example, if the current directory is MyDisk, the partial
pathname to specify the English directory is:
:PC-KIMMO:English
Thus if we are running MacPC-KIMMO while in the MyDisk directory and we
want to change to the English directory, we issue the command:
CD :PC-KIMMO:English
Here are some things to remember when using Macintosh pathnames with
the CD command:
Directory names are not case sensitive; if the directory name is
"English", you can refer to it as "english" or "ENGLISH".
A directory name used in a CD command cannot contain a space.
To change to the directory below the current one, use a partial
pathname; for example CD :ENGLISH.
To change to the directory immediately above the current one,
simply issue the command CD :: (two colons). To go up two
directories, type CD ::: (three colons), and so on.
To change to a directory that shares a parent with the current
directory, go up to the parent using colons and then specify the
directory names to go down to the sibling directory. For example, if
you are in the English directory and want to change to the Finnish
directory type CD ::FINNISH (which means, go up one directory and then
down to the FINNISH directory).
It is also possible to access files in a directory other than the current one
without changing directories. This can be done by specifying the file's
pathname when it it used in a command. The pathname follows the same
conventions as described above for the CD command. For example, the
command LOAD RULES :ENGLISH:ENGLISH.RUL will look for the file
ENGLISH.RUL in a directory named ENGLISH immediately below the current
directory.
8 DEFAULT FILE NAMES AND EXTENSIONS
If file names are used that are compatible with the MS-DOS version of PC-
KIMMO, the Macintosh version will obey the same default file name and
file name extension conventions. For example, to load the English rules
file, it is necessary to type only LOAD RULES ENGLISH (no dot at the end).
The same is true when you are accessing files in a folder other than the
current one; for example, LOAD RULES :ENGLISH:ENGLISH (no dot). 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. File names are not case sensitive.
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 folder:
MacPC-KIMMO executable PC-KIMMO program
ReadMe.DOC this file
Update.DOC program revision history
Register.FRM software registration form
Errata.DOC corrections to the book
Lexicon.LEX lexicon file template
Rules.RUL rules file template
PCKIMMO.TAK sample TAKE file
Demo.TAK TAKE file to run brief demo
This diskette also contains the following folders, each of which contains
sample PC-KIMMO applications. Each folder contains a TAKE file that will
run an automatic demonstration of the sample. For example, if you open
the CVCV folder, run MacPC-KIMMO, and enter the command "take 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 (you can also choose Quit from the Files menu).
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 implemention of the Soundex method
Tagalog Tagalog description
Turkish Turkish description
Zoque Zoque description
The following folder 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 September 14, 1990
--------
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.
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.
