Java 2 SDK

Japanese Documentation
Installation Instructions

Japanese Documentation Installation Instructions

This procedure describes how to install the Japanese version of the SDK documentation that you have already downloaded. The compressed file that you download is called the documentation bundle.

1. Check the bundle size
2. Where to unbundle your documentation
3. Unbundle your documentation
4. View the documentation

Check the bundle size

Before you download a file, notice that its byte size is provided on the download page. Once the download has completed, check that you have downloaded the full, uncorrupted software file.

We suggest that you install the Japanese SDK documentation inside your SDK software directory.

For example:

• Microsoft Windows: If your jdk1.3 directory is located at C:\jdk1.3, then your documentation bundle should be placed in C:\jdk1.3 before unbundling it.

• Solaris Operating Environment and Linux: if your SDK is installed at /usr/local/jdk1.3, then your documentation bundle should be placed in /usr/local/jdk1.3 before unbundling it.

Before unbundling, make sure the documentation bundle is inside the top-level directory of the SDK software. Unbundle the documentation using the appropriate utility: winzip, unzip, gunzip, or pkunzip. Your utility must support long file names.

• For .zip file:
  

  C:> unzip j2sdk1_3_0-update1-doc-ja.zip
  

  Note: If you're using another tool that doesn't preserve path names by default, be sure to specify that path names be preserved. If you're using pkunzip, for example, specify -d:

  C:> pkunzip -d j2sdk1_3_0-update1-doc-ja.zip
  

• For .tar.Z file:

  % uncompress j2sdk-1_3_0-update1-doc-ja.tar.Z
  % tar xvf j2sdk-1_3_0-update1-doc-ja.tar

• For .tar.gz file:

  % gunzip j2sdk-1_3_0-update1-doc-ja.tar.gz
  % tar xvf j2sdk-1_3_0-update1-doc-ja.tar

Unbundling the documentation bundle creates a docs/ja directory containing your Japanese SDK documents, as shown below.

Open the jdk1.3/docs/ja/index.html page in a browser. This is the front page and contents of the SDK documentation.

Installing the SDK software and Japanese documentation creates the following directory structure. The directories shown in bold are installed with the Japanese SDK documentation bundle.

                         jdk1.3
     ______________________|____________________________
    |    |    |    |     |   |  |   |     |         |   |
    |  README | LICENSE bin lib | include |         | docs
    |         |          |   |  |   |     |         |   |
README.html COPYRIGHT          jre    include-old  demo |
                              __|__       |         |   |
                             |     |                   ja
                            bin   lib                   |
                             |     |                    |
                                                        |
          ______________________________________________|
         |      |        |         |        | 	        |
        api   guide   relnotes  tooldocs  images    index.html

• Some non-Solaris OE versions of tar may not properly unbundle the compressed tar (tar.Z) and GZIP tar (tar.gz) versions of the docs. Old versions of WinZip and Cygnus GNU tar are two examples of such programs. This problem occurs because a few of the files have paths (including filenames) that exceed 99 characters, and there is no universal way of handling files of this length in the tar format. If you have a version of the jar tool, you can use that to unbundle the zip format. WinZip does unbundle "tar" files, but not if they contain paths that exceed 99 characters.

  If you use an old tar utility to unpack the .tar.Z or .tar.gz bundle, the files whose paths exceed 99 characters will be installed in the same directory where you are expanding the tar package, which is the wrong location, so links to them will be broken. For the list of files whose names exceed 99 characters, including the full, correct paths of their proper location, see: Correct Paths.

  Background: The original tar format supports a maximum path size of 99 characters. If you use Solaris OE tar, you will not see a problem, because Solaris OE tar extends this format beyond 99 characters but in a Solaris-only way. GNU tar has a different way of extending the format, so is incompatible with the Solaris tar.