6    Installing and Setting Up Japanese Document Full-Text Searching Tools

The Tru64 UNIX operating system offers two Japanese document full-text searching tools; MitakeSearch for online documents (midoc) and MitakeSearch for reference pages (miman). These tools use the Compaq Japanese full-text searching system, MitakeSearch, and can execute full-text search for any character string in an online document or reference page.

• The midoc tool searches a Japanese HTML document using the Web browser interface.

• The miman tool can search either a Japanese or English reference page using a command-line or Web interface. In comparison to the operating system apropos command, which executes a search with one of the keywords registered in the whatis database, miman executes a full-text search in a reference page.

Because the midoc and miman tools execute Web browser searches by means of a CGI script, you must install the tools on the system and set them up for the HTTP server. This chapter describes installation of the midoc and the miman tools and their required settings.

The midoc and miman kits are contained on the Tru64 UNIX Japanese Extensions CD-ROM.

For information on using the miman and midoc tools with the Browser interface, click the Help icon or button in the appropriate search window and refer to the online help.

For information on using the miman tool with the command-line interface, see miman(1).

For information on MitakeSearch, the Japanese full-text searching system, refer to the following Web page:

http://digital.compaq.co.jp/mitake/

6.1    Installing the midoc Software

Use the setld command to install MitakeSearch for Online Documents (midoc) . The expanded destination of the kit is fixed to the /var/opt/midoc directory and 27 MB of free space is required.

The following sections describe the procedure for installing the midoc software.

6.1.1    Securing the Expanded Destination of the Kit

Make sure that the /var/opt directory has at least 27 MB of free space. Expand the distribution kit under the /var/opt/midoc directory.

If the directory does not have sufficient free space, use the following steps to make a directory for midoc on a separate disk or partition and establish a symbolic link from the /var/opt/midoc directory.

1. Log in to the system as a root user.

2. Make the /usr/local/midoc directory:

   % mkdir -p /usr/local/midoc
   

3. Set root for the owner of the /usr/local/midoc directory:

   % chown root /usr/local/midoc
   

4. Set 755 for the permission mode of the /usr/local/midoc directory:

   % chmod 755 /usr/local/midoc
   

5. Link the /var/opt/midoc directory to the /usr/local/midoc directory:

   % ln -s /usr/local/midoc /var/opt/midoc
   

6.1.2    Installing the midoc Software From the Kit

The midoc kit is configured as a single unit with the IOSMIDOCnnn subset name, where nnn represents the version number of the midoc software. To install the midoc software, mount the Tru64 UNIX Japanese Extensions CD-ROM under the /mnt directory, and use the following setld load command:

% setld -l /mnt/midoc/kit

From the installation dialogue, select the midoc software subset for installation. For information on using the setld command, see theInstallation Guide and setld(8).

6.1.3    Setup After Installation

The midoc tool assumes that a search is executed using the Web browser by means of a CGI script. After midoc is installed, you must configure the HTTP server as well as the midoc software. The following sections describe how to configure HTTP and midoc.

6.1.3.1    Copying the Icon Files

Copy the following files, which are stored under the /var/opt/midoc/cgi-bin directory, to the HTTP server's icon directory. Use the http://host-name/icons/ URL to access the icon directory. If the icon directory does not exist, use the mkdir command to create one.

• midoc-c.gif

• midoc-next.gif

• midoc-prev.gif

• midoc-t.gif

• midoc-help.gif

• midoc-p.gif

• midoc-search.gif

• midoc-x.gif

After the files are copied, set the file protection to allow user access.

6.1.3.2    Copying the Perl Scripts

Copy the following Perl scripts, which are stored under the /var/opt/midoc/cgi-bin directory, to the CGI directory. Use the http://host-name/cgi-bin/ URL to access the CGI directory.

• midoc.pl

• midoc2html.pl

• libjconv.pl

After the scripts are copied, set the file protection to allow user access.

If your system is using MitakeSearch or miman, libjconv.pl already exists. These files are identical and can be used interchangeably.

6.1.3.3    Editing the Map File

Edit the map file (/var/opt/midoc/etc/urlmap.cgi) to enable the URL resulting from a midoc search to be mapped to a URL that can be displayed.

In general, the URL of the document registered in the midoc database must be similar to the mount point for the Tru64 UNIX Japanese Extensions CD-ROM (/usr/share/doclib/online), except that the URL host name is registered by means of the file:// protocol in localhost. Thus, all documents have been registered by means of a URL beginning with file://localhost/usr/share/doclib/online/.

The edit you make to the URL map file depends on whether the CD-ROM is mounted locally or mounted on the Web Server.

Consider the following two examples. In either case, the separator must be one [TAB] without inserting a blank.

If the Tru64 UNIX Japanese Extensions CD-ROM is mounted under the local system's /mnt directory and the midoc user executing the search accesses it as a local file, edit the URL map file as follows:

Example 6-1:  Accessing a CD-ROM Mounted Locally

Before edit:

file://localhost/usr/share/doclib/online/[TAB] http://hostname/path/

After edit:

file://localhost/usr/share/doclib/online/[TAB] file:/mnt/     
 

If the Tru64 UNIX Japanese Extensions CD-ROM is mounted on the Web server and is accessed by means of the URL http://hostname/document/, edit the URL map file as follows:

Example 6-2:  Accessing a CD-ROM Mounted on the Web Server

Before edit:

file://localhost/usr/share/doclib/online/[TAB] http://hostname/path/

After edit:

file://localhost/usr/share/doclib/online/[TAB] http://hostname/document/
 

If the files on the CD-ROM have been copied to disk with the same directory configuration, make the same edits to the URL map file.

6.1.4    Executing the Search

To execute the search CGI script, access the HTTP server that was set up in Section 6.1.3.3 by using the following URL:

  http://host-name/cgi-bin/midoc.pl

If the appropriate document cannot be displayed even by clicking the URL in the Search Results window, recheck the settings of the URL map file (/var/opt/midoc/etc/urlmap.cgi).

6.1.5    Uninstalling the midoc Software

To uninstall the midoc software, use the setld command:

% setld -d IOSMIDOCnnn

Where nnn is the version number of the midoc software subset. If you do not know the complete subset name for the installed midoc software, you can use setld -i | grep IOSMIDOC to display the name.

6.2    Installing the miman Software

Use the setld command to install MitakeSearch for Man Pages (miman). The expanded destination of the kit is fixed to the /var/opt/miman directory and 77 MB of free space is required.

The following sections describe the procedure for installing the miman software.

6.2.1    Securing the Expanded Destination of the Kit

Make sure that the /var/opt directory has at least 77 MB of free space. Expand the distribution kit under the /var/opt/midoc directory.

If the directory does not have sufficient free space, use the following steps to make a directory for miman on a separate disk or partition and establish a symbolic link from the /var/opt/miman directory.

For example, if you want the kit expanded under the /usr/local/miman directory because /usr/local has sufficient free space, use the following procedure.

1. Log in to the system as a root user.

2. Make the /usr/local/miman directory:

   % mkdir -p /usr/local/miman
   

3. Set root for the owner of the /usr/local/miman directory:

   % chown root /usr/local/miman
   

4. Set 755 for the permission mode of the /usr/local/miman directory:

   % chmod 755 /usr/local/miman
   

5. Link the /var/opt/miman directory to the /usr/local/miman directory:

   % ln -s /usr/local/miman /var/opt/miman
   

6.2.2    Installing the miman Software from the Kit

The miman kit is configured as a single unit with the IOSMIMANnnn subset name, where nnn represents the version number of the miman software. To install the miman software, mount the Tru64 UNIX Japanese Extensions CD-ROM under the /mnt directory, and use the following setld load command:

% setld -l /mnt/miman/kit

From the installation dialogue, select the miman software subset for installation. For information on using the setld command, see theInstallation Guide and setld(8).

6.2.3    Setup After Kit Expansion

You can set up the miman software for use with a command-line interface or with a Web interface.

• For command-line use, no setup is necessary. You can use miman immediately after expanding the kit. For information on using miman as a command, see miman(1).

• For Web use, you must configure the HTTP server as explained in this section.

• A miman search database is installed when you install the kit. For information about adding or deleting content from the database, see mimanctl(1).

To use the Search CGI and Schedule Management CGI Clients, execute the following steps after installing MitakaeSearch for Man Pages.

1. Copy the following files, stored under the /var/opt/miman/cgi-bin directory, to the HTTP server's icons directory. Use the http://host-name/icons/ URL to access the icon directory. If the icon directory does not exist, use the mkdir command to create one.

   • miman-c.gif

   • miman-go.gif

   • miman-help.gif

   • miman-m.jpg

   • miman-p.gif

   • miman-x.gif

   After the files are copied, set the file protection to allow user access to the files.

2. Copy the following Perl scripts, stored under the /var/opt/miman/cgi-bin directory, to the CGI directory. Use the http://host-name/cgi-bin/ URL to access the CGI directory.

   • miman.pl

   • miman2html.pl

   • libjconv.pl

   After the scripts are copied, set the file protection to allow user access.

To enable the Search CGI Client, specify the following URL in the Web browser:

   http://host-name/cgi-bin/miman.pl

6.2.4    Uninstalling the miman Software and Other Notes

• To uninstall the miman software, use the setld command. After uninstalling it, some files and directories you created might remain. Delete them manually.

  % setld -d IOSMIMANnnn
  

• Where nnn is the version number of the miman subset. If you do not know the complete subset name for the installed miman software, you can use setld -i | grep IOSMIMAN to display the name.

  In some rare cases, an error can occur during database update and destroy the database. If the database is destroyed, reinstall the kit. Before the reinstallation, be sure to uninstall the miman software. Reinstallation causes user-registered data to be lost.