AIX Version 4.3 Installation Guide

Chapter 7. Installing and Configuring the Documentation Search Service and Installing AIX Documentation

This chapter provides information about installing and configuring the documentation search service, as well as installing the documentation server and client. Also included are the steps you need to perform to install the online AIX documentation, which is contained on the AIX Version 4.3 Base Documentation CD and the AIX Version 4.3 Extended Documentation CD.

This chapter includes:

Introduction
Testing the Search Service
Installing the Server
Installing the Client
Installing the AIX Documentation

Introduction

With the documentation search service, users can search registered HTML documents using a search form that appears in the web browser. When users type words into the search form, the service searches for those words, and then presents a search results page containing links that lead to the documents containing the target words.

If the documentation search service is not already installed and configured on your computer, it is highly recommended that it be installed and configured now, since it is the search engine for the AIX documentation and the Web-based System Manager application. It is also used by some applications as the search function for their online documentation.

The AIX global search form allows users to search all documents that are registered on a computer. Users can access the global search form by typing docsearch on the command line or by clicking the search service icon in the CDE Desktop Help subpanel. Search forms that search only a subset of the registered documents may also be launched from "Search" links inside the document pages of applications such as Web-based System Manager.

The documentation search service is an optionally installable component of AIX. If you ordered a preinstalled system from the factory, the search service may have already been installed and configured at the factory.

If you are not sure that the documentation search service has been installed and configured on your computer, go to Testing the Search Service.
If you need to install or configure the search service, go to Installation of Server and Client.
If the documentation search service has been installed and configured on your computer, or you do not want to install it, go to Where Do I Go Next?

Testing the Search Service

If you are not sure if the search service is installed and configured, you should try the following test, which requires that you be running in the X-Windows System or the CDE Desktop:

At the command line, type: docsearch. You will see one of three results:

The search form appears, with no error messages. Try searching for a word to see if the search is working correctly.
- If the search works correctly, go to Where Do I Go Next? to complete the rest of your AIX installation tasks.
- If the search fails, go to Problem Determination in AIX Version 4.3 System Management Guide: Operating System and Devices after you have completed all of your tasks in this guide.
The browser opens, but you get a message saying that there are no volumes (indexes) to search. The search service may be installed, but the search service cannot find any installed documents that are registered with the search service.
Your next step is to install searchable documents. After you have installed some documents that register themselves with the search service (for example, the AIX Version 4.3 documentation), return to this chapter and retest the search service.

Go to Installing the AIX Documentation.
No browser appears, or the browser appears containing a message saying it cannot find the path or URL. The search service is not installed and configured correctly. Go to Installation of Server and Client to install and configure the search service.

Installation of Server and Client

A computer can be set up as either a documentation server or as a documentation client system. When users on a client computer request a search form or an HTML document, the request is sent to the web server on a documentation server which then sends back the requested object. When searches are performed, they are done on the server computer and the results are then sent back to the user on the client computer.

A documentation server computer has the following software installed:

Documentation search service server and client software
Documents
Document indexes
Web server software

A client computer needs only the documentation search service client software and a web browser installed.

If you have a standalone computer, both the server and client software are installed on the same standalone computer. Instead of going to a remote computer, requests from users on the standalone computer go to the web server software on their own computer. A documentation server on a network can also be made standalone in the sense that you can configure its web server software to accept only requests from users logged on to the documentation server computer.

The following sections describe the procedures for Installing the Server and Installing the Client.

Installing the Server

Use this procedure if you want to set up a computer to be a documentation server, where you will install your online documentation. A server can be a networked computer that serves remote clients, or it can be a standalone computer that serves only its own users.

To create a documentation search server, the following steps are completed in this sequence. Be sure to follow the instructions under each step:

Install the web server software
Configure and start your web server software
Install the documentation search service
Configure the documentation search service
Install or register your documentation
Complete the server installation

Install the Web Server Software

If the following software is not already installed on your system, install it now. If you are not sure what is already installed, type: smit list_installed.

A web browser that can display forms (the Netscape browser is on the AIX Version 4.3 Netscape Products CD).
Web server software that can run CGI (Common Gateway Interface) programs ( the Lotus Domino Go Webserver is on one of the AIX Version 4.3 Bonus Pack CDs).

Configure and Start your Web Server Software

Consult the documentation that came with your web server software to configure and start your web server software. Make note of and keep handy the full path names of the web server directories where the server starts looking for HTML documents and CGI programs, unless you are using the Lotus Domino Go webserver and you installed it in its default location. In addition, some web servers may not automatically create these directories. If not, you must create them before you continue.

You must also configure your web server software to allow access from the users and remote computers that will be using this computer as their documentation search server.

Install the Documentation Search Service

If the documentation search service is not already installed on your system, install it now. If you are not sure what is already installed, type: smit list_installed.

The AIX documentation search service (bos.docsearch) is contained on Volume 2 of the AIX Version 4.3 CD-ROM. This package must be installed after you have installed and configured your web server.

Notes:
Install all parts of the package, except that if you do not use the CDE Desktop, you do not have to install the Docsearch Client - CDE Desktop Icons and Actions fileset.

If you are installing the documentation search service on a system that has a previous version of the search service installed, the installation process may fail saying that it cannot install the IMN search package. If this happens, unselect the documentation search service for installation and then manually select just the IMN search package and install it. After that install completes, try again to install the Documentation Search Service package.

You may want this documentation server to be able to serve documents that are written in a language that is different than the language this computer is using during installation. If this is the case, you must install additional message filesets for the other languages you want to serve. The message filesets include translated error messages and the translated buttons and controls the appear in the search form.

For example, assume that your server is running in English when you are installing the docsearch package and you want users to be able to search both English and Spanish documents from the documentation server. The English messages will be automatically installed since that is the language in use during install. So you only need to manually select the Spanish message sets for installation. Additionally, you must also have the AIX Base Operating System locale (language environment) for Spanish installed.

There are two ways to install the search service messages for another language:

After you install the Documentation Search Service (docsearch), you can install the AIX locale (language environment) for the language you want to add. Do this even if you have already installed the locale before. This will automatically install all of that language's messages for all applications that are already installed on your computer. If you already installed the locale once, it will just install the messages for any applications you installed after you first installed the locale. This is the easiest technique, but the disadvantage is that it installs all messages for all applications installed on your computer. This makes install take longer and uses up more disk space. To install or update an entire locale, first install docsearch, then type the command smit mle_add_lang. Select the additional languages you want in both the cultural conventions and language translation fields. Installation may take a long time depending on how may other applications you have installed.
If the locale for the desired language was installed before the docsearch package was installed, you can just install the docsearch messages. In your installation tool, manually select just the docsearch message filesets for installation. The message filesets are not inside the docsearch package. They are stored in the AIX BOS messages packages (bos.msg locale) and are named DocSearch CDE Action - language and DocSearch Common Messages - language. You should always install the Common messages and only install the CDE messages if you have the desktop installed on your system. For example, assume that your server is running in English when you are installing and you want to be able to serve both English and Spanish documents from the documentation server. The English messages will be automatically installed. So you only need to manually select Spanish. You would look in the installation list under the heading bos.msg.es_ES and install the filesets DocSearch CDE Action - Spanish (if the desktop is installed) and DocSearch Common Messages - Spanish.

Configure the Documentation Search Service

There are three tools you can use to configure the search service:

Web-based System Manager
Configuration Assistant
SMIT.

Using Web-based System Manager

Change to root user. On a command line, type the fast path: wsm system to display the Web-based System Manager System container.
Double-click the Internet Environment icon to open it. The Default Browser page of the properties notebook displays.
In the Browser command field, type the command that launches the browser that you want to set as the default browser for all users on this computer. Include any flags that are required when a URL is included in the command. For example, if you would type the following on a command line: wonderbrowser -u http://www.rs6000.ibm.com/aix/library to open your wonderbrowser with the www.rs6000.ibm.com/aix/library page open inside, you would type the following into the field:
```
wonderbrowser -u
```
Note: Many browsers (for example, Netscape) do not require a flag.
Click OK to return to the System container.
Double-click the Internet Environment icon to reopen it. The Default Browser page of the properties notebook displays.
Select the Documentation Server tab. The Documentation Server page displays.
Select the Local server radio button.
Under the heading Location of documents and CGI programs on local server, select the web server software you installed on this computer. If the name of your web server software is not listed, select Other.
Note: If you have installed Lotus Domino Go Webserver or Internet Connection Server in a nondefault location on your system or you set up the servers to use nonstandard locations for their CGI-bin or HTML directories, you must select Other.
If you selected Other, type in the full path names of the CGI directory and the Documents directory. If you selected one of the default web server packages, skip to the next step.
In the Server port field, type in the port number that the web server software is using. The most commonly used port number is 80. Click OK.
Your documentation server is configured, and the configuration for the new web server software is now complete. Any users who were logged in when configuration was done must log out, and then log back in to activate the search service.

Go to Where Do I Go Next? for information on continuing your AIX installation tasks.

Using Configuration Assistant

The Configuration Assistant is an automated guide designed to walk you through the configuration tasks one step at a time. It asks you a series of questions and then configures the system for you. This is the simplest configuration tools to use.

As root user, enter configassist on the command line.
When the Configuration Assistant appears, press the Next button.
On the second screen, select the task Configure Online Documentation and Search, then press Next.
Follow the instructions on the following screens to complete configuration.

Using SMIT:

Change to root user. On a command line, type the fast path: smit web_configure to open the web configuration screen.
Select Change/Show Default Browser. Type into the field the command that launches the browser that you want to be the default browser for all users on this computer. Include any flags that are required when a URL is included in the command. For example, if you would type the following on a command line: wonderbrowser -u http://www.rs6000.ibm.com/aix/library to open your wonderbrowser with the www.rs6000.ibm.com/aix/library page open inside, you would type the following into the field:
```
wonderbrowser -u
```
Note: Many browsers (for example, Netscape) do not require a flag.
Return to the web configuration main menu. Select Change Documentation and Search Server.
On the "Documentation and Search Server LOCATION" screen, click on List and select local - this computer for server location. Select OK.
On the "Web Server SOFTWARE" screen, click on List. Select the web server software you are using.
Note: If you have installed Lotus Domino Go Webserver or Internet Connection Server in a nondefault location on your system or you set up the servers to use nonstandard locations for their CGI-bin or HTML directories, you must select Other. Select OK.
When the next screen appears, type in the full path names of the two directories. If you selected one of the two default servers, the path names should already be displayed. If you set up your web server to use some port other than the standard port 80, type in the port number. Select OK. SMIT then configures your system. When it is completed, you should see a Documentation server configuration completed! message at the bottom of the results panel.
You can now close SMIT. The documentation search service installation and configuration is now complete. Any users who were logged in when configuration was done must log out and then log back in to activate the search service.

Install or Register your Documentation

Before any document can be searched using the documentation search service, it must have an index created, and the index must be registered with the search service.

Some applications ship prebuilt document indexes inside their install package. When the application is installed, the indexes are automatically registered. The AIX Version 4.3 documentation and the Web-based System Manager application both ship prebuilt indexes for their documents.

You can also create indexes for your own HTML documents and register them with the search engine so that they can be searched online. For further information on how to create indexes, see AIX Documentation Search Service in AIX Version 4.3 General Programming Concepts: Writing and Debugging Programs.

Complete the Server Installation

The installation of the documentation search service is complete. Go to Where Do I Go Next? for information on continuing your AIX installation tasks.

Installing the Client

Use this procedure if you want to set up a computer to be a client of a remote documentation search server computer. When users on this computer want to search online documentation, the request is sent to a remote documentation search server, where the search is conducted and the results then sent back to a web browser on this client computer.

To create a search client, complete the following steps.

Install the Client Software
Configure the Documentation Search Service

Install the Client Software

If the following software is not already installed on your client system, install it now. If you are not sure what is already installed, type: smit list_installed.

A web browser that can display forms (the Netscape browser is on the AIX Version 4.3 Netscape Products CD).
The AIX documentation search service package (the bos.docsearch package is on Volume 2 of the AIX Version 4.3 CD-ROM). You do not need to install the Docsearch Server fileset. From this package, install:
- Docsearch Client fileset
- Docsearch Client - CDE Desktop Icons and Actions fileset if you are using the CDE Desktop.
The Docsearch Message filesets . When you install the docsearch package it automatically installs the current language of your computer. However, if you want to be able to search documents in other languages, you must also install the docsearch message sets for those languages. The message filesets are stored in the AIX BOS messages packages (bos.msg locale)and are named DocSearch CDE Action - language and DocSearch Common Messages - language. You do not need to install the CDE message set if you are not using the desktop.
Note: You must also have the AIX BOS locale (language environment) installed for any language you want to use.
For example, assume that your server is running in English when you are installing and you want to be able to serve English and Spanish documents from the documentation server. The English messages will be automatically installed. So you only need to manually select Spanish. You would look in the installation list under the heading bos.msg.es_ES and install the filesets DocSearch CDE Action - Spanish and DocSearch Common Messages - Spanish.

Configure the Documentation Search Service

You can configure the documentation search service by using either of the AIX system management tools, Web-based System Manager or SMIT.

Using Web-based System Manager:

On the client computer, change to root user. On a command line, type the fast path: wsm system to display the Web-based System Manager System container.
Double-click on Internet Environment icon to open it. The Default Browser page of the properties notebook displays.
In the Browser command field, type the command that launches the browser that you want to set as the default browser for all users on this computer. Include any flags that are required when a URL is included in the command. For example, if you would type the following on a command line: wonderbrowser -u http://www.rs6000.ibm.com/aix/library to open your wonderbrowser with the www.rs6000.ibm.com/aix/library page open inside, you would type the following into the field:
```
wonderbrowser -u
```
Note: Many browsers (for example, Netscape) do not require a flag.
Click OK to return to the System container.
Double-click the Internet Environment icon to reopen it. The Default Browser page of the properties notebook displays.
Select the Documentation Server tab. The Documentation Server page displays.
Select the Remote server radio button.
Under the Remote server button, type into the Computer name field the name of the documentation server computer. This is the server computer that contains the documents that you want this client computer to be able to search.
In the Server port field, type in the port number the web server software is using. The most commonly used port is 80.
Click OK to complete the configuration. Close the Web-based System Manager application.
Your client computer is configured, the documentation search service is installed, and the configuration for the new web server software is now complete. Any users who were logged in when configuration was done must log out, and then log back in to activate the search service.

Installation of the documentation search service is complete. Go to Where Do I Go Next? for information on continuing your AIX installation tasks.

Using SMIT:

On the client computer, change to root user. On a command line, type the fast path: smit web_configure to open the web configuration screen.
Select Change/Show Default Browser. Type into the field the command that launches the browser that you want to be the default browser for all users on this computer. Include any flags that are required when a URL is included in the command. For example, if you would type the following on a command line: wonderbrowser -u http://www.rs6000.ibm.com/aix/library to open your wonderbrowser with the www.rs6000.ibm.com/aix/library page open inside, you would type the following into the field:
```
wonderbrowser -u
```
Note: Many browsers (for example, Netscape) do not require a flag.
Return to the web configuration main menu. Select Change Documentation and Search Server.
On the "Documentation Search Server LOCATION" screen, click on List and select Remote computer for server location. Select OK.
When the next screen appears, type into the NAME of remote documentation server field the name of the remote documentation search server computer that you want this client computer to send its search requests to. You can type in a name or an IP address. If the web server on the remote server is set to use some port other than the standard port 80, type in the port number. Select OK to configure your client system. When it is done, you should see a Documentation server configuration completed! message at the bottom of the results panel.
The documentation search functions on this client computer should now be ready to use. Any users logged on this client computer before configuration finished must log off and then log back in to use the search functions.

Go to Where Do I Go Next? for information on continuing your AIX installation tasks.

Installing the AIX Documentation

Accessing AIX Documentation from the Internet

It is not necessary to install the AIX Documentation onto your computer. Instead all of the documentation can be utilized from the internet at the following URL:

http://www.rs6000.ibm.com/aix/library

However, if you install other documentation on your computer, and you are using the AIX Documentation Search Service on your computer to do searches, it will only search the registered documentation that is installed on this computer and will not search the AIX Documentation at the above web site.

Installing Documentation from the AIX Documentation CDs

The AIX Version 4.3 documentation is contained on two compact discs:

AIX Version 4.3 Base Documentation CD, containing the following types of documentation:
- User guides
- System management guides
- Application programmer guides
- All commands reference volumes
- Files reference
- Technical reference volumes used by application programmers
AIX Version 4.3 Extended Documentation CD, containing the following types of documentation:
- Adapter guide and reference books
- Technical specifications describing industry standard functions
- Technical reference volumes used by system programmers

Note: The AIX Version 4.3 Base Documentation CD and the AIX Version 4.3 Extended Documentation CD can be either installed or mounted. If you mount the CD, the entire CD is mounted. You cannot install part of the CD and mount the remainder.

These compact discs contain AIX and related products documentation designed for use with an HTML 3.2 web browser, such as the Netscape browser that is shipped with the AIX Version 4.3 Bonus Pack. The discs require a CD-ROM drive.

The documentation information is made accessible by loading it onto the hard disk or by mounting the documentation CD in the CD-ROM drive. While mounting the CD saves on the amount of hard disk space used, it requires the CD be kept in the CD-ROM drive at all times. Also, searching the documentation from the CD-ROM drive can be significantly slower (in some cases up to 10 times slower) than searching the information if it is installed on a harddisk.

If you want to install the documentation on your harddisk, go to Installing Documentation from the AIX Documentation CDs. If you want to mount the documentation CD, go to Mounting a Documentation CD.

You can install all of the AIX documentation from the AIX Version 4.3 Base Documentation CD and the AIX Version 4.3 Extended Documentation CD or you can selectively install pieces of the documentation. Some documentation may have previously been installed with the operating system or other licensed products. Run the lslpp command to find out which packages and filesets are already installed on your system.

The installation application you use, either Web-based System Manager or SMIT, will create a temporary mount point for the CD.

Note: For additional information on installing the documentation, see Installing Optional Software and Service Updates .

Mounting a Documentation CD

The first time you access the documentation from your CD, you must:

Create a CD file system
Mount the CD file system
Run the link script.

Note: You must have root user authority or be a member of the system group to perform these tasks.

Create a CD File System

These steps describe how to create a file system where you can mount your CD:

Insert the CD in the drive, following the instructions in your operator guide, and run the following SMIT command: smit crcdrfs.
On the Add a CD-ROM File System screen, list all available devices.
Highlight the CD-ROM device you plan to use and press Enter.
Highlight the MOUNT POINT entry field.
If you are creating a file system for the AIX Version 4.3 Base Documentation CD, type the following, but do not press Enter until you get to Step 7:
```
/infocd
```
If you are creating a file system for the AIX Version 4.3 Extended Documentation CD, type the following, but do not press Enter until you get to Step 7:
```
/exinfocd
```
Highlight the Mount AUTOMATICALLY at system restart? field. You have two choices:
1. Yes - Mount the documentation CD every time you start the system.
2. No - Mount manually when you need the documentation CD.
When you have finished making all changes to all the entry fields, press Enter and exit SMIT.

Mount the CD File System

These steps describe how to mount your CD to the file system you just created:

At the system prompt, enter the following smit command: smit mountfs. The Mount a File System screen appears, highlighting the FILESYSTEM name field.
Note: Select yes to mount the CD as READ-ONLY.
Click the List button next to the FILE SYSTEM names field. Click on the file system name that contains /infocd if you are mounting the base CD, or click on the line that contains /exinfocd if you are mounting the extended CD.
Press Enter, and when the Command: status field changes to OK, exit SMIT.

Note: If the CD is ejected from the system while it is still mounted, the connection is broken and you cannot access the information. To remove the CD from the system, run the unlink script and then unmount the file system using the unmount command before ejecting the CD. To access the CD again, you must remount the CD file system, using the mount or smit command.

Run the Link Script

To mount the AIX Version 4.3 Base Documentation CD, type the following two commands:
```
cd /infocd

./linkbasecd
```
To mount the AIX Version 4.3 Extended Documentation CD, type the following two commands:
```
cd /exinfocd

./linkextcd
```

Unmounting a Documentation CD

To unmount the CD, you must first run the unlink script and then unmount the CD:

To unmount the AIX Version 4.3 Base Documentation CD, type the following three commands:
```
cd /infocd

./unlinkbasecd

umount /infocd
```
To unmount the AIX Version 4.3 Extended Documentation CD, type the following three commands:
```
cd /exinfocd

./unlinkextcd

umount /exinfocd
```

Removing Book Links

To save disk space, your system administrator may have omitted some of the AIX documentation. Some of the installed documentation may still contain links to these books. If you click on a link to one of the missing books, you will receive an error message. It is possible to remove these links to resolve this problem by running the following command as root:

resolve_links

This command will determine the books that are installed, and then remove all links to the missing documentation.

Note: Thousands of pages of documentation are searched through and modified by the command, so it may run for a long period of time. However, the documentation may still by accessed by users while the resolve_links command is running.

Where Do I Go Next?

At this point, you may want to do one or more additional tasks before using your system:

The software you installed may contain README files with late-breaking news. For information on how to view README files, refer to Viewing README Files .
You might want to create a new backup of your system at this point. Go to Backing Up Your System .
For information on how to view the AIX documentation, go to Accessing Online Information in AIX Version 4.3 Quick Beginnings.
For further information about the documentation search service, go to Documentation Search Service in AIX Version 4.3 System Management Guide: Operating System and Devices.