Using MKSearch source releases

This is a draft document that explains how to unpack and configure an MKSearch source distribution. This draft has been prepared in advance of any actual release.

Unzip the source

MKSearch is distributed in a compressed ZIP file format and requires a ZIP utility program to extract the original files. Popular programs include unzip on GNU/Linux systems and WinZip for Windows.

unzip on GNU/Linux

Download the MKSearch source and save it into a suitable directory, such as your home directory. Your home directory can be referred to by the prefix ~/. The example commands below create a new directory called ~/mksearch and unzips the source to it.

cd ~/

mkdir ~/mksearch

unzip ~/MKSearch-0.1.zip -d ~/mksearch

As the source files are unzipped you will see a long list of the new file names, each prefixed "inflating: ...".

Unzip on Windows

Download the MKSearch source and save it in a suitable location, such as your desktop. If you have WinZip installed or another program that is registered to open zip files, double click on the MKSearch zip file. In WinZip, choose the Extract button and use the Extact dialogue to select or create a directory to which MKSearch will be unzipped. Click the smaller Extract button to continue.

As the source files are unzipped you will see a dialogue box that rapidly lists the new file names, each prefixed "Extracting ...".

Executable permissions for GNU/Linux

On GNU/Linux systems, all source files should be unzipped with the settings signified by the current user's umask settings. This should not set files to be executable by default, but MKSearch includes bash scripts that need to modified to run.

Following the example directory path above, this command sets all the bash script files in the MKSearch bin directory to be executable.

chmod -R +x ~/mksearch/bin/*.sh

Set environment variables

The MKSearch build scripts use environment variables instead of hard coded file paths so that they are easy to configure and run on different systems. See the README.txt file in the bin directory of your MKSearch installation for full details. The variables that must be set are:

• mk_home
• mk_build
• JAVA_14

If you plan to use the GNU compiler for Java (GCJ), you should also set the CLASSPATH variable.

Build and run the indexer

After completing these steps you are ready to build the MKSearch system. See the separate how to articles Build MKSearch with GCJ and Run the MKSearch indexer.