Installation and Configuration Supplement

Working with the DB2 Universal Database Documentation Files in a Client/Server Environment

To set up the DB2 Universal Database documentation on a central server, you should perform the following steps:

  1. Install a DB2 server, DB2 client, or DB2 Connect product and select the option to install documentation.
  2. As an option, you can customize the HTML files you have installed. The DB2 Information page is named index.htm and is located in the product's doc\html sub-directory. Depending on the set of products that you install, some of the links in this file might point to non-existent books. You can remove these links if you do not intend to install the books on the central server. You can also add your own links to local resources such as your own operations manual or help desk. The DB2 Information page also contains a Search field in which you can enter search terms or phrases.
    Note:Keep in mind that DB2 service releases might include an updated version of the DB2 Information page, so be sure to keep a backup copy of any changes you make.
  3. As an option, you might want to move or copy the DB2 Universal Database HTML files:

    To copy the files on the same machine, you can use a command that preserves the directory structure, such as xcopy or cp -r. It is important to preserve the original directory structure, because the book files use relative links to return to the list of books, and the list of books uses relative links to each book.

    To copy the files to a different machine, you can use an archiving tool such as pkzip or tar. Again, use options that preserve the directory structure in the new location.

    If you just wanted to transfer a few books, you might use ftp to transfer the index.htm file and all the files in some of the book subdirectories. The files should be transferred in binary so that the *.gif files and any national characters such as accented letters are preserved.

  4. As an option on Windows and OS/2 operating systems, you might want to customize the Information Center.

    The DB2 Information Center uses a set of mapping files to locate the online information that it displays. By default, it looks for the online HTML information in the doc\html sub-directory tree in the directory where DB2 is installed. If you move the HTML files, such as to a web server or network drive, the Information Center can only find them if the *.ndx files are updated. In the sqllib\help directory of DB2, look for files with the *.ndx extension. Each one represents a page in the Information Center notebook.

    To update the Information Center to find the online information on the x: drive, edit each *.ndx file in turn. Be sure to use an editor that handles Unicode. Change all occurrences of the string file:///%DB2PATH%/doc/html to reflect the new location of the HTML files. For example, for a web server you might change the string to http://servername/path/to/db2/docs. For a network drive, you might change the string to file:///x:/path/to/db2/docs. It is important to preserve the directory structure wherever the files are located, because the Information Center expects that, for example, the SQL Reference files are in a directory named db2s0, and so on.


[ Top of Page | Previous Page | Next Page ]