Using the documentation offline

This page has not been liked. Updated 12/14/16, 2:27 AM by CarrieMillerTags: None

The online version of this product documentation is the supported version. However, the documentation is provided in a format for offline use for convenience.


  • These steps require Internet access and a machine that is running on a Microsoft Windows XP or higher operating system.
  • Before you can use the Eclipse application, you must have a compatible level of Java runtime environment for Eclipse installed on your machine and configured to run from the command-line.  On a Windows machine, you might need to add the Java bin directory to your path environment variable. See the Eclipse website for details.

Complete the following steps to create your own offline version of the documentation:

  1. Go to the Eclipse downloads site:

  2. Download the most current version of the Eclipse Classic application.

  3. Create a directory on your local system for the Eclipse Classic application.

    For example:


  4. Install the contents of the zip file that you downloaded from the Eclipse downloads site. Open the zip file. Extract the eclipse directory in the zip file to your c:\eclipse_offline directory. Your c:\eclipse_offline directory now has a c:\eclipse_offline\eclipse subdirectory.

  5. Within the C:\eclipse_offline directory, create command files to start and stop the Eclipse application.
    1. Locate the file within the C:\eclipse_offline\eclipse\plugins folder where N.N.N.vNNN refers to the Eclipse Classic version that you downloaded.

    2. Use a text editor to create the file, ic_start.cmd.
      1. Add the following statements into the file:

        java -classpath eclipse\plugins\ -eclipsehome eclipse -port 8680 -command start -noexec -clean

      2. Ensure that you use the correct name of the jar file. You must also specify the listener port for Eclipse. In this example, the port number is 8680.

      3. Save the ic_start.cmd file.

    3. Use a text editor to create the file, ic_end.cmd.
      1. Add the following statements into the file:

        java -classpath eclipse\plugins\ -eclipsehome eclipse -command shutdown

      2. Ensure that you use the correct name of the jar file.

      3. Save the ic_end.cmd file.

  6. Download the documentation plug-ins that you want to view offline. 

    The following links include the entire set of information for the release, including product and API documentation: 

    WebSphere eXtreme Scale V8.6 ( 12.5 MB):

    WebSphere DataPower XC10 Appliance V2.5 (5.2 MB):

  7. Extract the documentation plug-ins within the plugins subdirectory.

  8. Run the ic_start.cmd file by double-clicking the filename or run the command from the command-line. This results in a command window that stays open until you run the ic_end.cmd file.

  9. When the ic_start.cmd file is running, point your browser to http://localhost:[port_number] to launch the offline WebSphere Application Server documentation on your local system. In this example, the URL is: http://localhost:8680/help/index.jsp

  10. To stop the offline information center, run the the ic_end.cmd file.