source: general/prog/openjdk.xml@ 718593a

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY ojdk-upd                  "31">
  <!ENTITY ojdk-bd                   "b13">
  <!ENTITY ojdk-tarball              "jdk8u&ojdk-upd;-&ojdk-bd;.tar.bz2">
  <!ENTITY ojdk-repo                 "http://hg.openjdk.java.net/jdk8u/jdk8u">
  <!ENTITY ojdk-download             "&ojdk-repo;/archive/&ojdk-tarball;">

  <!ENTITY anduin-download           "http://anduin.linuxfromscratch.org/files/BLFS/OpenJDK-&openjdk-version;">

  <!ENTITY ojdk-md5sum               "1e9071c62fd02a5b0c2874d9967b38e7">
  <!ENTITY ojdk-size                 "384 KB">

  <!ENTITY corba-download            "&anduin-download;/corba.tar.xz">
  <!ENTITY corba-md5sum              "35763069a8a69b1510d70d7e77a95fea">
  <!ENTITY corba-size                "915 KB">

  <!ENTITY hotspot-download          "&anduin-download;/hotspot.tar.xz">
  <!ENTITY hotspot-md5sum            "76deba8b0c7ee042df4cc441d29b1da0">
  <!ENTITY hotspot-size              "6.2 MB">

  <!ENTITY jaxp-download             "&anduin-download;/jaxp.tar.xz">
  <!ENTITY jaxp-md5sum               "baf2f923fe29a7ceff6d0f7cb5331b9d">
  <!ENTITY jaxp-size                 "2.2 MB">

  <!ENTITY jaxws-download            "&anduin-download;/jaxws.tar.xz">
  <!ENTITY jaxws-md5sum              "5d99e16e146e920b5fa3360b26bb13a8">
  <!ENTITY jaxws-size                "2.2 MB">

  <!ENTITY jdk-download              "&anduin-download;/jdk.tar.xz">
  <!ENTITY jdk-md5sum                "79f0b2cd008497a8011bfbc2bd7f2b01">
  <!ENTITY jdk-size                  "36.2 MB">

  <!ENTITY langtools-download        "&anduin-download;/langtools.tar.xz">
  <!ENTITY langtools-md5sum          "19d9a21aa51e8afb80d0a35681c2467f">
  <!ENTITY langtools-size            "2.0 MB">

  <!ENTITY nashorn-download          "&anduin-download;/nashorn.tar.xz">
  <!ENTITY nashorn-md5sum            "7ed0b17f2d925d3263a344b7fc746d24">
  <!ENTITY nashorn-size              "1.9 MB">

  <!ENTITY jtreg-version             "4.1-b10">
  <!ENTITY jtreg-download            "https://adopt-openjdk.ci.cloudbees.com/job/jtreg/lastStableBuild/artifact/jtreg&jtreg-version;.tar.gz">
  <!ENTITY jtreg-md5sum              "2e112b5863c777426fbbbadeeb9972e1">
<!-- The md5sum varies, because people at adopt-openjdk rebuild the package
without changing the name of the tarball -->
  <!ENTITY jtreg-size                "2.6 MB">

  <!ENTITY icedtea-web-download      "http://icedtea.classpath.org/download/source/icedtea-web-&icedtea-web-version;.tar.gz">

  <!ENTITY ojdk-buildsize           "3.1 GB (additional 350 MB for tests)">
  <!ENTITY ojdk-time                "15 SBU (additional 126 SBU for tests)">
]>

<sect1 id="openjdk"
       xreflabel="OpenJDK-&openjdk-version;">
  <?dbhtml filename="openjdk.html" ?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>OpenJDK-&openjdk-version;</title>

  <indexterm zone="openjdk">
    <primary sortas="a-OpenJDK">OpenJDK</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to OpenJDK</title>

    <para>
      <application>OpenJDK</application> is an open-source implementation
      of Oracle's Java Standard Edition platform.
      <application>OpenJDK</application> is useful for developing
      <application>Java</application> programs, and provides a complete
      runtime environment to run <application>Java</application> programs.
    </para>

    &lfs77_checked;

    <note>
      <para>
        A browser plugin and webstart implementation, as well as a
        pulseaudio sound backend are provided by the Icedtea project. To provide
        a complete implementation, you will need to later install
        <xref linkend="icedtea-web"/> and <xref linkend="icedtea-sound"/>.
      </para>
    </note>

    <para>
      OpenJDK is GPL'd code, with a special exception made for non-free
      projects to use these classes in their proprietary products.
      In similar fashion to the LGPL, which allows non-free programs to link
      to libraries provided by free software, the
      <ulink url="http://openjdk.java.net/legal/gplv2+ce.html">GNU
      General Public License, version 2, with the Classpath Exception</ulink>
      allows third party programs to use classes provided by free software
      without the requirement that the third party software also be free. As
      with the LGPL, any modifications made to the free software portions of a
      third party application, must also be made freely available.
    </para>

    <note>
      <para>
        The <application>OpenJDK</application> source includes a very
        thorough, open source test suite using the
        <application>JTreg</application> test harness. The testing instructions
        below allow to test the just built JDK for reasonable compatibility
        with the proprietary Oracle JDK. However, in order for an independent
        implementation to claim compatibility, it must pass a proprietary
        <application>JCK/TCK</application> test suite. No claims of
        compatibility, even partial compatibility, may be made without passing
        an approved test suite.
      </para>

      <para>
        Oracle does provide free community access, on a case by case basis, to
        a closed toolkit to ensure 100% compatibility with its proprietary JDK.
        Neither the binary version provided on the <xref linkend="java"/> page
        nor the JVM built with the instructions below have been tested against
        the <ulink
  url="http://openjdk.java.net/groups/conformance/JckAccess/jck-access.html">
        TCK</ulink>. Any version that is built using the instructions given,
        cannot claim to be compatible with the proprietary JDK, without the
        user applying for, and completing the compatibility tests themselves.
      </para>

      <para>
        With that in mind, the binaries produced using this build method are
        regularly tested against the TCK by the members listed on the site
        above. In addition to the community license above, an educational,
        non-commercial license for the TCK can be obtained from <ulink
        url="http://www.oracle.com/technetwork/java/index-137188.html">
        here</ulink>.
      </para>
    </note>

    <bridgehead renderas="sect3">Source Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>OpenJDK Root Package
          <simplelist>
            <member>Download: <ulink url="&ojdk-download;"/></member>
            <member>Download MD5 sum: &ojdk-md5sum;</member>
            <member>Download Size: &ojdk-size;</member>
          </simplelist>
        </para>
      </listitem>
    </itemizedlist>

    <para>
      The following files may be downladed from the OpenJDK mercurial
      repository using the addresses <ulink
      url="&ojdk-repo;/&lt;component&gt;/archive/&ojdk-tarball;"/>,
      where &lt;component&gt; is the name of the JVM component (corba,
      hostspot, and so on), but that involves renaming the downloaded files,
      and renaming the extracted directories.
      For convenience, the BLFS editors have made the files available in an LFS
      website.
    </para>

    <itemizedlist spacing="compact">
      <listitem>
        <para>Corba Source
          <simplelist>
            <member>Download: <ulink url="&corba-download;"/></member>
            <member>Download MD5 sum: &corba-md5sum;</member>
            <member>Download Size: &corba-size;</member>
          </simplelist>
        </para>
      </listitem>
      <listitem>
        <para>Hotspot Source
          <simplelist>
            <member>Download: <ulink url="&hotspot-download;"/></member>
            <member>Download MD5 sum: &hotspot-md5sum;</member>
            <member>Download Size: &hotspot-size;</member>
          </simplelist>
        </para>
      </listitem>
      <listitem>
        <para>JAXP Source
          <simplelist>
            <member>Download: <ulink url="&jaxp-download;"/></member>
            <member>Download MD5 sum: &jaxp-md5sum;</member>
            <member>Download Size: &jaxp-size;</member>
          </simplelist>
        </para>
      </listitem>
      <listitem>
        <para>JAXWS Source
          <simplelist>
            <member>Download: <ulink url="&jaxws-download;"/></member>
            <member>Download MD5 sum: &jaxws-md5sum;</member>
            <member>Download Size: &jaxws-size;</member>
          </simplelist>
        </para>
      </listitem>
      <listitem>
        <para>Langtools Source
          <simplelist>
            <member>Download: <ulink url="&langtools-download;"/></member>
            <member>Download MD5 sum: &langtools-md5sum;</member>
            <member>Download Size: &langtools-size;</member>
          </simplelist>
        </para>
      </listitem>
      <listitem>
        <para>JDK Source
          <simplelist>
            <member>Download: <ulink url="&jdk-download;"/></member>
            <member>Download MD5 sum: &jdk-md5sum;</member>
            <member>Download Size: &jdk-size;</member>
          </simplelist>
        </para>
      </listitem>
      <listitem>
        <para>Nashorn Source
          <simplelist>
            <member>Download: <ulink url="&nashorn-download;"/></member>
            <member>Download MD5 sum: &nashorn-md5sum;</member>
            <member>Download Size: &nashorn-size;</member>
          </simplelist>
        </para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &ojdk-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &ojdk-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>

    <itemizedlist spacing='compact'>
      <listitem>
        <para>
          Optional package (to get an icon for the
          <filename>openjdk-8-policytool.desktop</filename> file):
          <ulink url="&icedtea-web-download;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Optional test harness: <ulink url="&jtreg-download;"/>
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">OpenJDK Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required Dependencies</bridgehead>
    <para role="required">
      An existing binary (<xref linkend="java"/> or an earlier built
      version of this package),
      <xref linkend="alsa-lib"/>,
      <xref linkend="cpio"/>,
      <xref linkend="cups"/>,
      <xref linkend="unzip"/>,
      <xref linkend="which"/>,
      <xref linkend="xorg7-lib"/>, and
      <xref linkend="zip"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="cacerts"/> and
      <xref linkend="giflib"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="mercurial"/> and
      <xref linkend="twm"/> (for the tests)
    </para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/openjdk"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of OpenJDK</title>

    <para>
      Unlike other packages in BLFS, the <application>OpenJDK</application>
      source packages are distributed in multiple tar balls. You need to first
      extract the source root from <filename>&ojdk-tarball;</filename>, change
      into the extracted directory, then proceed with the following
      instructions:
    </para>

<screen><userinput>tar -xf ../corba.tar.xz      &amp;&amp;
tar -xf ../hotspot.tar.xz    &amp;&amp;
tar -xf ../jaxp.tar.xz       &amp;&amp;
tar -xf ../jaxws.tar.xz      &amp;&amp;
tar -xf ../jdk.tar.xz        &amp;&amp;
tar -xf ../langtools.tar.xz  &amp;&amp;
tar -xf ../nashorn.tar.xz</userinput></screen>

    <para>
      If you have downloaded the test harness, unpack it too:
    </para>

<screen><userinput>tar -xf ../jtreg&jtreg-version;.tar.gz</userinput></screen>

<!--TODO: it might be better to add instructions for the cacerts file at
this place and to use the switch "with-cacerts-file" -->

    <para>
      Fix an issue with the new (since 5.1.0) giflib API:
    </para>

<screen><userinput>sed -e 's/DGifCloseFile(gif/&amp;, NULL/' \
    -e '/DGifOpen/s/c)/c, NULL)/'     \
    -i jdk/src/share/native/sun/awt/splashscreen/splashscreen_gif.c</userinput></screen>

    <para>
      Fix a bug in a shell script used to set the flags for
      <command>make</command>:
    </para>

<screen><userinput>sed 's/\([ \t]\)\]\([^\]\)/\1I]\2/g' \
    -i hotspot/make/linux/makefiles/adjust-mflags.sh</userinput></screen>

    <note>
      <para>
        Before proceeding, you should ensure that your environment
        <envar>PATH</envar> variable contains the location of the Java
        compilers used for bootstrapping <application>OpenJDK</application>.
        This is the only requirement for the environment. Modern Java
        installations do not need <envar>JAVA_HOME</envar> and
        <envar>CLASSPATH</envar> is not used here. Furthermore, OpenJDK
        developers recommand to unset <envar>JAVA_HOME</envar>.
      </para>

      <para>
        The build system does not support the <option>-j</option> switch in
        <envar>MAKEFLAGS</envar>.
      </para>
    </note>

    <para>Configure and build the package with the following commands
    (--with-milestone value can be modified to fit user preferences):</para>

<screen><userinput>unset JAVA_HOME               &amp;&amp;
sh ./configure                \
   --with-update-version=&ojdk-upd;   \
   --with-build-number=&ojdk-bd;    \
   --with-milestone=BLFS      \
   --enable-unlimited-crypto  \
   --with-zlib=system         \
   --with-giflib=system       &amp;&amp;
make DEBUG_BINARIES=true all</userinput></screen>

    <para>
      It seems that the test infrastructure of OpenJDK is a work in
      progress, so that testing the newly built JVM involves several steps.
      First, it is better to run the test suite in a frame buffer on a
      different display, using Xvfb:
    </para>

<!-- Careful with the && below:
"export DISPLAY=... && somecommand &" exports only DISPLAY to "somecommand"
but not to the current environment, and
"echo $! .... &&" does not echo the right PID. SO all && suppressed.-->
<screen role='nodump'><userinput>if [ -n "$DISPLAY" ]; then
  OLD_DISP=$DISPLAY
fi
export DISPLAY=:20
nohup Xvfb $DISPLAY                              \
           -fbdir $(pwd)                         \
           -pixdepths 8 16 24 32 > Xvfb.out 2>&amp;1 &amp;
echo $! > Xvfb.pid
echo Waiting for Xvfb to initialize; sleep 1
nohup twm -display $DISPLAY \
          -f /dev/null > twm.out 2>&amp;1            &amp;
echo $! > twm.pid
echo Waiting for twm to initialize; sleep 1
xhost +</userinput></screen>

    <para>
      Then, it is necessary to modify some files:
    </para>

<screen role='nodump'><userinput>echo -e "
jdk_all = :jdk_core           \\
          :jdk_svc            \\
          :jdk_beans          \\
          :jdk_imageio        \\
          :jdk_sound          \\
          :jdk_sctp           \\
          com/sun/awt         \\
          javax/accessibility \\
          javax/print         \\
          sun/pisces          \\
          com/sun/java/swing" >> jdk/test/TEST.groups &amp;&amp;
sed -e 's/all:.*jck.*/all: jtreg/' \
    -i langtools/test/Makefile</userinput></screen>

    <para>
      Some variables have to be set:
    </para>

<screen role='nodump'><userinput>JT_JAVA=$(type -p javac | sed 's@/bin.*@@') &amp;&amp;
JT_HOME=$(pwd)/jtreg                        &amp;&amp;
PRODUCT_HOME=$(echo $(pwd)/build/*/images/j2sdk-image)</userinput></screen>

    <para>
      The tests are run as follows:
    </para>

<!-- no && here either, because the first "make" may return an error -->
<screen role='nodump'><userinput>LANG=C make -k -C test                      \
            JT_HOME=${JT_HOME}              \
            JT_JAVA=${JT_JAVA}              \
            PRODUCT_HOME=${PRODUCT_HOME} all
LANG=C ${JT_HOME}/linux/bin/jtreg -a -v:fail,error \
                -dir:$(pwd)/hotspot/test    \
                -k:\!ignore                 \
                -jdk:${PRODUCT_HOME}        \
                :jdk</userinput></screen>

    <para>
      The test results can be compared to
      <ulink url="http://download.java.net/openjdk/testresults/8/">these
      results</ulink>.
      Finally, stop the virtual frame buffer and clean up:
    </para>

<screen role='nodump'><userinput>kill -9 `cat twm.pid`  &amp;&amp;
kill -9 `cat Xvfb.pid` &amp;&amp;
rm -f Xvfb.out twm.out &amp;&amp;
rm -f Xvfb.pid twm.pid &amp;&amp;
if [ -n "$OLD_DISP" ]; then
  DISPLAY=$OLD_DISP
fi</userinput></screen>

    <para>Install the package with the following commands as the
    <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>find build/*/images/j2sdk-image -iname \*.jar -exec chmod a+r {} \; &amp;&amp;
chmod a+r build/*/images/j2sdk-image/lib/ct.sym &amp;&amp;
find build/*/images/j2sdk-image -iname \*.diz -delete &amp;&amp;
find build/*/images/j2sdk-image -iname \*.debuginfo -delete &amp;&amp;
cp -R build/*/images/j2sdk-image /opt/OpenJDK-&openjdk-version; &amp;&amp;
chown -R root:root /opt/OpenJDK-&openjdk-version;</userinput></screen>

    <para>If desired, you may install a .desktop file corresponding to an entry
    in a desktop menu for <command>policytool</command>. First, you need to
    obtain an icon from <xref linkend="icedtea-web"/>:</para>

<screen><userinput>tar -xf ../icedtea-web-&icedtea-web-version;.tar.gz  \
        icedtea-web-&icedtea-web-version;/javaws.png \
        --strip-components=1</userinput></screen>

    <para>Now, as <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>mkdir -pv /usr/share/applications &amp;&amp;

cat &gt; /usr/share/applications/openjdk-8-policytool.desktop &lt;&lt; "EOF" &amp;&amp;
<literal>[Desktop Entry]
Name=OpenJDK Java Policy Tool
Name[pt_BR]=OpenJDK Java - Ferramenta de Pol&#237;tica
Comment=OpenJDK Java Policy Tool
Comment[pt_BR]=OpenJDK Java - Ferramenta de Pol&#237;tica
Exec=/opt/jdk/bin/policytool
Terminal=false
Type=Application
Icon=javaws
Categories=Settings;</literal>
EOF

install -v -Dm0644 javaws.png /usr/share/pixmaps/javaws.png</userinput></screen>

    <para>The choice of pt_BR is just an example. You can add any translation
    by adding lines corresponding to your locale, e.g. for fr_FR,
    <quote>Name[fr_FR]=</quote> and <quote>Comment[fr_FR]=</quote> with the
    appropriate text as values.</para>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <command>sh configure...</command>: the top level
      <filename>configure</filename> is a wrapper around the autotools one.
      It is not executable and must be run through <command>sh</command>.
    </para>

    <para>
      <option>--with-boot-jdk</option>: This switch provides the
      location of the temporary <application>JDK</application>. It is normally
      not needed if <command>java</command> is found in the <envar>PATH</envar>.
    </para>

    <para>
      <parameter>--with-update-version</parameter>: Currently, the build
      system does not include the update number in the version string. It has
      to be specified here.
    </para>

    <para>
      <parameter>--with-build-number</parameter>: Again, the build
      system does not include the build  number in the version string. It has
      to be specified here too.
    </para>

    <para>
      <parameter>--with-milestone</parameter>: Used to customize the
      version string.
    </para>

    <para>
      <parameter>--enable-unlimited-crypto</parameter>: Because of limitations
      on the usage of cryptography in some countries, there is the possibility
      to limit the size of encryption keys and the use of some algorithms in a
      policy file. This switch allows to ship a policy file with no
      restriction. It is the responsability of the user to ensure proper
      adherence to the law.
    </para>

    <para>
      <parameter>--with-zlib=system, --with-giflib=system</parameter>: Allows
      to use the system libraries instead of the bundled ones.
    </para>

    <para>
      <option>--with-jobs=N</option>: Allows to set the number
      of jobs for <command>make</command> equal to N. The default is the
      result of a calculation involving the available memory and the number
      of processors. Note that even if you specify N=1, some parallelization
      may be used during the build. The SBU given above are with parallel jobs
      disabled, on a single processor, single core, virtual machine.
    </para>

    <para>
      <option>--with-cacerts-file=...</option>: Specifies where to find a
      <filename>cacerts</filename> file. Otherwise, an empty one is created.
      You can get it from an earlier version of the package, or using the
      script below to generate one.
    </para>
    <para>
      <command>make DEBUG_BINARIES=true all</command>: The build fails
      if DEBUG_BINARIES is not set to true.
    </para>

    <para>
      <command>find ... -iname '*.jar' -exec chmod a+r {} \;</command>
      and following line: Fix permission in some library files, in order to
      allow all users to access them.
    </para>

    <para>
      <command>find ... -iname '*.diz' -delete</command>: This command and the
      the next one remove redundant files.
    </para>

  </sect2>

  <sect2 role="configuration"
         id="openjdk-config"
         xreflabel="Configuring OpenJDK">
    <title>Configuring OpenJDK</title>

    <sect3>
      <title>Configuration Information</title>

      <para>
        There are now two <application>OpenJDK</application> SDKs installed
        in <filename class="directory">/opt</filename>. You should decide on
        which one you would like to use as the default. For example if you
        decide to use the precompiled <application>OpenJDK</application>, do
        the following as the <systemitem class="username">root</systemitem>
        user:
      </para>

<screen role="root"><userinput>ln -v -nsf OpenJDK-&openjdk-version;-bin /opt/jdk</userinput></screen>

      <para>The information below assumes your system is set up using the
      instructions found in <quote><xref
      linkend="postlfs-config-profile"/></quote>. You may need to extract the
      relevant information below and incorporate it into your system's startup
      files if your system is set up differently.</para>

      <para>Add the following <filename>openjdk.sh</filename> shell startup
      file to the <filename>/etc/profile.d</filename> directory with the
      following commands as the <systemitem class="username">root</systemitem>
      user:</para>

<screen role="root"><userinput>cat &gt; /etc/profile.d/openjdk.sh &lt;&lt; "EOF"
<literal># Begin /etc/profile.d/openjdk.sh

# Set JAVA_HOME directory
JAVA_HOME=/opt/jdk

# Set ANT_HOME directory
ANT_HOME=/opt/ant

# Adjust PATH
pathappend $JAVA_HOME/bin PATH
pathappend $ANT_HOME/bin PATH

# Auto Java CLASSPATH
# Copy jar files to, or create symlinks in this directory

AUTO_CLASSPATH_DIR=/usr/share/java

pathprepend . CLASSPATH

for dir in `find ${AUTO_CLASSPATH_DIR} -type d 2>/dev/null`; do
    pathappend $dir CLASSPATH
done

for jar in `find ${AUTO_CLASSPATH_DIR} -name "*.jar" 2>/dev/null`; do
    pathappend $jar CLASSPATH
done

export JAVA_HOME ANT_HOME CLASSPATH
unset AUTO_CLASSPATH_DIR dir jar

# End /etc/profile.d/openjdk.sh</literal>
EOF</userinput></screen>

    <para>Finally, add the man pages to <application>man_db</application>'s
    configuration. As the <systemitem class="username">root</systemitem>
    user:</para>

<screen role="root"><userinput>cat >> /etc/profile.d/extrapaths.sh &lt;&lt; "EOF" &amp;&amp;
<literal># Begin Java addition
pathappend /opt/jdk/man       MANPATH
# End Java addition</literal>
EOF


cat &gt;&gt; /etc/man_db.conf &lt;&lt; "EOF" &amp;&amp;
<literal># Begin Java addition
MANDATORY_MANPATH     /opt/jdk/man
MANPATH_MAP           /opt/jdk/bin     /opt/jdk/man
MANDB_MAP             /opt/jdk/man     /var/cache/man/jdk
# End Java addition</literal>
EOF

mkdir -p /var/cache/man
mandb -c /opt/jdk/man</userinput></screen>

    <para>To test if the man pages are correctly installed, issue
    <command>source /etc/profile</command> and <command>man java</command> to
    display the respective man page.</para>

    </sect3>

    <sect3 id='ojdk-certs'>
      <title>Install or update the JRE Certificate Authority Certificates
      (cacerts) file</title>

      <para>
        Use the following procedure to install the
        <filename>cacerts</filename> or to generate a new one if
        <xref linkend="cacerts"/> have been updated. First, if it is not
        already present, generate the <command>mkcacerts</command> script
        as the <systemitem class="username">root</systemitem> user:
      </para>

<screen role="root"><userinput>cat &gt; /opt/jdk/bin/mkcacerts &lt;&lt; "EOF"
<literal>#!/bin/sh
# Simple script to extract x509 certificates and create a JRE cacerts file.

function get_args()
    {
        if test -z "${1}" ; then
            showhelp
            exit 1
        fi

        while test -n "${1}" ; do
            case "${1}" in
                -f | --cafile)
                    check_arg $1 $2
                    CAFILE="${2}"
                    shift 2
                    ;;
                -d | --cadir)
                    check_arg $1 $2
                    CADIR="${2}"
                    shift 2
                    ;;
                -o | --outfile)
                    check_arg $1 $2
                    OUTFILE="${2}"
                    shift 2
                    ;;
                -k | --keytool)
                    check_arg $1 $2
                    KEYTOOL="${2}"
                    shift 2
                    ;;
                -s | --openssl)
                    check_arg $1 $2
                    OPENSSL="${2}"
                    shift 2
                    ;;
                -h | --help)
                    showhelp
                    exit 0
                    ;;
                *)
                    showhelp
                    exit 1
                    ;;
            esac
        done
    }

function check_arg()
    {
        echo "${2}" | grep -v "^-" > /dev/null
        if [ -z "$?" -o ! -n "$2" ]; then
            echo "Error:  $1 requires a valid argument."
            exit 1
        fi
    }

# The date binary is not reliable on 32bit systems for dates after 2038
function mydate()
    {
        local y=$( echo $1 | cut -d" " -f4 )
        local M=$( echo $1 | cut -d" " -f1 )
        local d=$( echo $1 | cut -d" " -f2 )
        local m

        if [ ${d} -lt 10 ]; then d="0${d}"; fi

        case $M in
            Jan) m="01";;
            Feb) m="02";;
            Mar) m="03";;
            Apr) m="04";;
            May) m="05";;
            Jun) m="06";;
            Jul) m="07";;
            Aug) m="08";;
            Sep) m="09";;
            Oct) m="10";;
            Nov) m="11";;
            Dec) m="12";;
        esac

        certdate="${y}${m}${d}"
    }

function showhelp()
    {
        echo "`basename ${0}` creates a valid cacerts file for use with IcedTea."
        echo ""
        echo "        -f  --cafile     The path to a file containing PEM"
        echo "                         formated CA certificates. May not be"
        echo "                         used with -d/--cadir."
        echo ""
        echo "        -d  --cadir      The path to a directory of PEM formatted"
        echo "                         CA certificates. May not be used with"
        echo "                         -f/--cafile."
        echo ""
        echo "        -o  --outfile    The path to the output file."
        echo ""
        echo "        -k  --keytool    The path to the java keytool utility."
        echo ""
        echo "        -s  --openssl    The path to the openssl utility."
        echo ""
        echo "        -h  --help       Show this help message and exit."
        echo ""
        echo ""
    }

# Initialize empty variables so that the shell does not pollute the script
CAFILE=""
CADIR=""
OUTFILE=""
OPENSSL=""
KEYTOOL=""
certdate=""
date=""
today=$( date +%Y%m%d )

# Process command line arguments
get_args ${@}

# Handle common errors
if test "${CAFILE}x" == "x" -a "${CADIR}x" == "x" ; then
    echo "ERROR!  You must provide an x509 certificate store!"
    echo "\'$(basename ${0}) --help\' for more info."
    echo ""
    exit 1
fi

if test "${CAFILE}x" != "x" -a "${CADIR}x" != "x" ; then
    echo "ERROR!  You cannot provide two x509 certificate stores!"
    echo "\'$(basename ${0}) --help\' for more info."
    echo ""
    exit 1
fi

if test "${KEYTOOL}x" == "x" ; then
    echo "ERROR!  You must provide a valid keytool program!"
    echo "\'$(basename ${0}) --help\' for more info."
    echo ""
    exit 1
fi

if test "${OPENSSL}x" == "x" ; then
    echo "ERROR!  You must provide a valid path to openssl!"
    echo "\'$(basename ${0}) --help\' for more info."
    echo ""
    exit 1
fi

if test "${OUTFILE}x" == "x" ; then
    echo "ERROR!  You must provide a valid output file!"
    echo "\'$(basename ${0}) --help\' for more info."
    echo ""
    exit 1
fi

# Get on with the work

# If using a CAFILE, split it into individual files in a temp directory
if test "${CAFILE}x" != "x" ; then
    TEMPDIR=`mktemp -d`
    CADIR="${TEMPDIR}"

    # Get a list of staring lines for each cert
    CERTLIST=`grep -n "^-----BEGIN" "${CAFILE}" | cut -d ":" -f 1`

    # Get a list of ending lines for each cert
    ENDCERTLIST=`grep -n "^-----END" "${CAFILE}" | cut -d ":" -f 1`

    # Start a loop
    for certbegin in `echo "${CERTLIST}"` ; do
        for certend in `echo "${ENDCERTLIST}"` ; do
            if test "${certend}" -gt "${certbegin}"; then
                break
            fi
        done
        sed -n "${certbegin},${certend}p" "${CAFILE}" > "${CADIR}/${certbegin}.pem"
        keyhash=`${OPENSSL} x509 -noout -in "${CADIR}/${certbegin}.pem" -hash`
        echo "Generated PEM file with hash:  ${keyhash}."
    done
fi

# Write the output file
for cert in `find "${CADIR}" -type f -name "*.pem" -o -name "*.crt"`
do

    # Make sure the certificate date is valid...
    date=$( ${OPENSSL} x509 -enddate -in "${cert}" -noout | sed 's/^notAfter=//' )
    mydate "${date}"
    if test "${certdate}" -lt "${today}" ; then
        echo "${cert} expired on ${certdate}! Skipping..."
        unset date certdate
        continue
    fi
    unset date certdate
    ls "${cert}"
    tempfile=`mktemp`
    certbegin=`grep -n "^-----BEGIN" "${cert}" | cut -d ":" -f 1`
    certend=`grep -n "^-----END" "${cert}" | cut -d ":" -f 1`
    sed -n "${certbegin},${certend}p" "${cert}" > "${tempfile}"
    echo yes | env LC_ALL=C "${KEYTOOL}" -import                     \
                                         -alias `basename "${cert}"` \
                                         -keystore "${OUTFILE}"      \
                                         -storepass 'changeit'       \
                                         -file "${tempfile}"
    rm "${tempfile}"
done

if test "${TEMPDIR}x" != "x" ; then
    rm -rf "${TEMPDIR}"
fi
exit 0</literal>
EOF

chmod -c 0755 /opt/jdk/bin/mkcacerts</userinput></screen>

  <note>
    <para>
      Doing a very large copy/paste directly to a terminal may result in a
      corrupted file.  Copying to an editor may overcome this issue.
    </para>
  </note>

    <para>If you need to generate a <filename>cacerts</filename> file,
    and there is already one in
    <filename class="directory">/opt/jdk/jre/lib/security</filename>, it
    is better to make a backup. Then, you can create a new one, as the
    <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>/opt/jdk/bin/mkcacerts            \
        -d "/etc/ssl/certs/"      \
        -k "/opt/jdk/bin/keytool" \
        -s "/usr/bin/openssl"     \
        -o "/opt/jdk/jre/lib/security/cacerts"</userinput></screen>

    <para>Use the following commands to check if the
    <filename>cacerts</filename> file has been successfully installed:</para>

<screen role="root"><userinput>cd /opt/jdk
bin/keytool -list -keystore jre/lib/security/cacerts</userinput></screen>

    <para>At the prompt "Enter keystore password:", press the "Enter" key if
    there is no keystore password defined. If the <filename>cacerts</filename>
    file was installed correctly, you will see a list of the certificates with
    related information for each one. If not, you need to reinstall
    them.</para>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>appletviewer, extcheck, idlj, jar,
        jarsigner, java, javac, javadoc, javah, javap, java-rmi.cgi,
        jcmd, jconsole, jdb, jdeps, jhat, jinfo, jjs, jmap, jps,
        jrunscript, jsadebugd, jstack, jstat, jstatd, keytool, mkcacerts,
        native2ascii, orbd, pack200, policytool, rmic, rmid, rmiregistry,
        schemagen, serialver, servertool, tnameserv, unpack200,
        wsgen, wsimport, and xjc</seg>
        <seg>/opt/OpenJDK-&openjdk-version;/lib/*, and
        /opt/OpenJDK-&openjdk-version;/jre/lib/*</seg>
        <seg>/opt/OpenJDK-&openjdk-version;</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="appletviewer">
        <term><command>appletviewer</command></term>
        <listitem>
          <para>allows to run applets outside of a web browser.</para>
          <indexterm zone="openjdk appletviewer">
            <primary sortas="b-appletviewer">appletviewer</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="extcheck">
        <term><command>extcheck</command></term>
        <listitem>
          <para>checks a specified jar file for title and version conflicts
          with any extensions installed in the
          <application>OpenJDK</application> software.</para>
          <indexterm zone="openjdk extcheck">
            <primary sortas="b-extcheck">extcheck</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="idlj">
        <term><command>idlj</command></term>
        <listitem>
          <para>generates Java bindings from a given IDL file.</para>
          <indexterm zone="openjdk idlj">
            <primary sortas="b-idlj">idlj</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jar">
        <term><command>jar</command></term>
        <listitem>
          <para>combines multiple files into a single jar archive.</para>
          <indexterm zone="openjdk jar">
            <primary sortas="b-jar">jar</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jarsigner">
        <term><command>jarsigner</command></term>
        <listitem>
          <para>signs jar files and verifies the signatures and integrity
          of a signed jar file.</para>
          <indexterm zone="openjdk jarsigner">
            <primary sortas="b-jarsigner">jarsigner</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="java-prog">
        <term><command>java</command></term>
        <listitem>
          <para>launches a Java application by starting a Java runtime
          environment, loading a specified class and invoking its main
          method.</para>
          <indexterm zone="openjdk java-prog">
            <primary sortas="b-java-prog">java</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="javac">
        <term><command>javac</command></term>
        <listitem>
          <para>reads class and interface definitions, written in the
          Java programming language, and compiles them into bytecode
          class files.</para>
          <indexterm zone="openjdk javac">
            <primary sortas="b-javac">javac</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="javadoc">
        <term><command>javadoc</command></term>
        <listitem>
          <para>parses the declarations and documentation comments in a
          set of Java source files and produces a corresponding set of
          HTML pages describing the classes, interfaces, constructors,
          methods, and fields.</para>
          <indexterm zone="openjdk javadoc">
            <primary sortas="b-javadoc">javadoc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="javah">
        <term><command>javah</command></term>
        <listitem>
          <para>generates C header and source files
          that are needed to implement native methods.</para>
          <indexterm zone="openjdk javah">
            <primary sortas="b-javah">javah</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="javap">
        <term><command>javap</command></term>
        <listitem>
          <para>disassembles a Java class file.</para>
          <indexterm zone="openjdk javap">
            <primary sortas="b-javap">javap</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="java-rmi.cgi">
        <term><command>java-rmi.cgi</command></term>
        <listitem>
          <para>is the Java RMI client.</para>
          <indexterm zone="openjdk java-rmi.cgi">
            <primary sortas="b-java-rmi.cgi">java-rmi.cgi</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jcmd">
        <term><command>jcmd</command></term>
        <listitem>
          <para>is a utility to send diagnostic command requests to a running
          Java Virtual Machine.</para>
          <indexterm zone="openjdk jcmd">
            <primary sortas="b-jcmd">jcmd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jconsole">
        <term><command>jconsole</command></term>
        <listitem>
          <para>is a graphical console tool to monitor and manage both
          local and remote Java applications and virtual machines.</para>
          <indexterm zone="openjdk jconsole">
            <primary sortas="b-jconsole">jconsole</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jdb">
        <term><command>jdb</command></term>
        <listitem>
          <para>is a simple command-line debugger for Java classes.</para>
          <indexterm zone="openjdk jdb">
            <primary sortas="b-jdb">jdb</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jdeps">
        <term><command>jdeps</command></term>
        <listitem>
          <para>shows the package-level or class-level dependencies of
          Java class files.</para>
          <indexterm zone="openjdk jdeps">
            <primary sortas="b-jdeps">jdeps</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jhat">
        <term><command>jhat</command></term>
        <listitem>
          <para>parses a java heap dump file and allows viewing it
          in a web browser.</para>
          <indexterm zone="openjdk jhat">
            <primary sortas="b-jhat">jhat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jinfo">
        <term><command>jinfo</command></term>
        <listitem>
          <para>prints Java configuration information for a given Java
          process, core file, or a remote debug server.</para>
          <indexterm zone="openjdk jinfo">
            <primary sortas="b-jinfo">jinfo</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jjs">
        <term><command>jjs</command></term>
        <listitem>
          <para>is a command-line tool used to invoke the Nashorn engine. It
          can be used to interpret one or several script files, or to run
          an interactive shell.</para>
          <indexterm zone="openjdk jjs">
            <primary sortas="b-jjs">jjs</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jmap">
        <term><command>jmap</command></term>
        <listitem>
          <para>prints shared object memory maps or heap memory details
          of a given process, core file, or a remote debug server.</para>
          <indexterm zone="openjdk jmap">
            <primary sortas="b-jmap">jmap</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jps">
        <term><command>jps</command></term>
        <listitem>
          <para>lists the instrumented JVMs on the target system.</para>
          <indexterm zone="openjdk jps">
            <primary sortas="b-jps">jps</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jrunscript">
        <term><command>jrunscript</command></term>
        <listitem>
          <para>is a command line script shell.</para>
          <indexterm zone="openjdk jrunscript">
            <primary sortas="b-jrunscript">jrunscript</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jsadebugd">
        <term><command>jsadebugd</command></term>
        <listitem>
          <para>attaches to a Java process or core file and acts as a
          debug server.</para>
          <indexterm zone="openjdk jsadebugd">
            <primary sortas="b-jsadebugd">jsadebugd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jstack">
        <term><command>jstack</command></term>
        <listitem>
          <para>prints Java stack traces of Java threads for a given
          Java process, core file, or a remote debug server.</para>
          <indexterm zone="openjdk jstack">
            <primary sortas="b-jstack">jstack</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jstat">
        <term><command>jstat</command></term>
        <listitem>
          <para>displays performance statistics for an instrumented JVM.</para>
          <indexterm zone="openjdk jstat">
            <primary sortas="b-jstat">jstat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jstatd">
        <term><command>jstatd</command></term>
        <listitem>
          <para>is an RMI server application that monitors for the creation
          and termination of instrumented JVMs.</para>
          <indexterm zone="openjdk jstatd">
            <primary sortas="b-jstatd">jstatd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="keytool">
        <term><command>keytool</command></term>
        <listitem>
          <para>is a key and certificate management utility.</para>
          <indexterm zone="openjdk keytool">
            <primary sortas="b-keytool">keytool</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mkcacerts">
        <term><command>mkcacerts</command></term>
        <listitem>
          <para> is a simple script to extract x509 certificates and create
          a JRE cacerts file using <command>keytool</command>.</para>
          <indexterm zone="openjdk mkcacerts">
            <primary sortas="b-mkcacerts">mkcacerts</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="native2ascii">
        <term><command>native2ascii</command></term>
        <listitem>
          <para> converts files that contain non-supported character encoding
          into files containing Latin-1 or Unicode-encoded characters.</para>
          <indexterm zone="openjdk native2ascii">
            <primary sortas="b-native2ascii">native2ascii</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="orbd">
        <term><command>orbd</command></term>
        <listitem>
          <para>is used to enable clients to transparently locate and invoke
          persistent objects on servers in the CORBA environment.</para>
          <indexterm zone="openjdk orbd">
            <primary sortas="b-orbd">orbd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pack200">
        <term><command>pack200</command></term>
        <listitem>
          <para>is a Java application that transforms a jar file into a
          compressed pack200 file using the Java gzip compressor.</para>
          <indexterm zone="openjdk pack200">
            <primary sortas="b-pack200">pack200</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="policytool">
        <term><command>policytool</command></term>
        <listitem>
          <para>creates and manages a policy file graphically.</para>
          <indexterm zone="openjdk policytool">
            <primary sortas="b-policytool">policytool</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rmic">
        <term><command>rmic</command></term>
        <listitem>
          <para>generates stub and skeleton class files for remote objects
          from the names of compiled Java classes that contain remote
          object implementations.</para>
          <indexterm zone="openjdk rmic">
            <primary sortas="b-rmic">rmic</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rmid">
        <term><command>rmid</command></term>
        <listitem>
          <para>starts the activation system daemon.</para>
          <indexterm zone="openjdk rmid">
            <primary sortas="b-rmid">rmid</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rmiregistry">
        <term><command>rmiregistry</command></term>
        <listitem>
          <para>creates and starts a remote object registry on the specified
          port on the current host.</para>
          <indexterm zone="openjdk rmiregistry">
            <primary sortas="b-rmiregistry">rmiregistry</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="schemagen">
        <term><command>schemagen</command></term>
        <listitem>
          <para>is a Java XML binding schema generator.</para>
          <indexterm zone="openjdk schemagen">
            <primary sortas="b-schemagen">schemagen</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="serialver">
        <term><command>serialver</command></term>
        <listitem>
          <para>returns the serialVersionUID for one or more classes in a
          form suitable for copying into an evolving class.</para>
          <indexterm zone="openjdk serialver">
            <primary sortas="b-serialver">serialver</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="servertool">
        <term><command>servertool</command></term>
        <listitem>
          <para>provides an ease-of-use interface for application programmers
          to register, unregister, startup and shutdown a server.</para>
          <indexterm zone="openjdk servertool">
            <primary sortas="b-servertool">servertool</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tnameserv">
        <term><command>tnameserv</command></term>
        <listitem>
          <para>starts the Java IDL name server.</para>
          <indexterm zone="openjdk tnameserv">
            <primary sortas="b-tnameserv">tnameserv</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="unpack200">
        <term><command>unpack200</command></term>
        <listitem>
          <para>is a native implementation that transforms a packed file
          produced by <application>pack200</application> into a jar
          file.</para>
          <indexterm zone="openjdk unpack200">
            <primary sortas="b-unpack200">unpack200</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="wsgen">
        <term><command>wsgen</command></term>
        <listitem>
          <para>generates JAX-WS portable artifacts used in JAX-WS
          web services.</para>
          <indexterm zone="openjdk wsgen">
            <primary sortas="b-wsgen">wsgen</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="wsimport">
        <term><command>wsimport</command></term>
        <listitem>
          <para>generates JAX-WS portable artifacts.</para>
          <indexterm zone="openjdk wsimport">
            <primary sortas="b-wsimport">wsimport</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xjc">
        <term><command>xjc</command></term>
        <listitem>
          <para>is a Java XML binding compiler.</para>
          <indexterm zone="openjdk xjc">
            <primary sortas="b-xjc">xjc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>