Chapter 13. Documentation Library Service

Introduction

The Documentation Library Service allows you to read, navigate, and search online HTML documents. It provides library application that appears in your web browser. The application includes links to read installed documents and a search form that you can use to search for text. When you search, a results page displays the results of the search with links to the documents containing the search target words.

Two types of forms are provided: a global search form that shows all the volumes installed on a search server, and a specific search form that just searches a specific set of volumes such as the manuals for an application.

The documentation library service allows you to search documents that have been registered with the search service. Registration is done by the system administrator. You cannot search the internet or any unregistered documents on your search server.

If you write HTML documents at your site, your system administrator can add these documents to the documentation library so that you can read and search the documents.

Using the Documentation Library Service

To use the Library:

• To read the documentation installed in your system's default library, do one of the following:
  • Type docsearch at the command line.
  • Open the CDE Desktop Help subpanel. Click on the documentation search service icon (it looks like binoculars).

    Note: If you have a copy of the 4.3.0 or above version of the AIX CD, you can read it on a PC. Insert the CD into the CD-ROM drive o your PC. If the documentation CD is version 4.3.3 or newer, use a web browser to open the CD file called "readme.htm" that is in the top directory of the CD. If you have a 4.3.0 to 4.3.2 version of the Base Documentation CD, open the file:

     usr/share/man/info/en_US/a_doc_lib/aixgen/topnav/topnav.htm

    If you have a 4.3.0 to 4.3.2 version of the Extended Documentation CD, open the file:

    usr/share/man/info/en_US/a_doc_lib/aixgen/wxinfnav/topnav.htm

• To open a library stored on a remote documentation server, type:

  http://<server_name>[:<port_number>]/cgi-bin/ds_form

  into your browser's URL field. This opens the global search form to search the documents stored on the server with the name you specified in <server_name>.

  Note: You only need to type the <port_number> if the port is not the standard 80.

  For example, if you want to search the registered documents on a search server named "hinson" and it uses port 80, type:

  http://hinson/cgi-bin/ds_form

  Once the search form for a server appears in your browser, you can create a bookmark that takes you back to the server. Your system administrator can also create a web page that contains links to all the different documentation servers in an organization.

  The AIX documentation is also available for reading and searching at the internet site www.rs6000.ibm.com/aix/library. Note that while this site contains the AIX manuals, it may not contain other documentation installed on your local documentation server.

• Specific search forms are usually launched from search links inside HTML documents. They typically appear on the pages of applications manuals or help files. For example, a "search" link is on each page in the AIX library. Clicking on one of these search links launches a specific search form that allows you to search just the AIX library volumes.

• Select the volumes you want to search. Click on the checkbox next to each volume name displayed. By default, all volumes are searched unless you specify otherwise.

After the library application opens, you can click on the Help link in the upper right corner for instructions on how to use the library.

How to Change the AIX Documentation Language

By default, when you open the CDE Desktop icons for the AIX Documentation Search Service or the AIX Base Library, the documents that are displayed appear in the same language as your CDE Desktop.

However, there may be reasons that you want to see the documentation in a language that is different than your desktop language. For example, you may run your desktop in your native language, but the manuals may only be available in English. You can change your documentation language so that documents appear in a different language than that used in your desktop.

Note: These techniques do not affect the language used if you are opening a document or search form from an HTML link inside another document. These techniques only affect the language used for the AIX Documentation Search Service or the AIX Base Library desktop icons.

Note: Make sure there is documentation installed for the language you want to use.

You can change your documentation language by running the following command:

/usr/bin/chdoclang <locale>

where <locale> is replaced by the AIX locale name that will be the new language for viewing and searching documentation. Locale names can be found in the AIX Locale Naming Conventions table.

Note: You must log out and then log back in to see the language change take effect.

Note: If you are using the CDE Desktop, you must also edit your Desktop file $HOME/.dtprofile so that your documentation language setting in your $HOME/.profile file will be read during CDE login. To do this, complete the following steps:

1. Open your .dtprofile file in an editor by typing:

   dtpad $HOME/.dtprofile

2. Find the line that contains this text:

   DTSOURCEPROFILE=true

3. If there are any # (comment) characters at the start of that line, delete just the # characters, not the entire line. If there are no # characters, you can just close the editor.

4. Save your changed .dtprofile file.

You are now ready to log out and log back in.

For example, if you want to change your documentation language to Spanish (es_ES), type the following command:

/usr/bin/chdoclang es_ES

Then log out and log back in to your desktop.

After you change your documentation language, you can delete the language setting so that documentation will again appear in the same language as your desktop. To delete your language setting, type the following command:

/usr/bin/chdoclang -d

Then log out and log back in to your desktop.