source: archive/icedtea-web.xml@ 541e056

<?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 icedtea-web-download-http "http://icedtea.wildebeest.org/download/source/icedtea-web-&icedtea-web-version;.tar.gz">
  <!ENTITY icedtea-web-download-ftp  " ">
  <!ENTITY icedtea-web-md5sum        "f55d3b47c657a3603b05c637ca8a4572">
  <!ENTITY icedtea-web-size          "2.0 MB">
  <!ENTITY icedtea-web-buildsize     "35 MB">
  <!ENTITY icedtea-web-time          "0.3 SBU">
]>

<sect1 id="icedtea-web" xreflabel="IcedTea-Web-&icedtea-web-version;">
  <?dbhtml filename="icedtea-web.html"?>

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

  <title>IcedTea-Web-&icedtea-web-version;</title>

  <indexterm zone="icedtea-web">
    <primary sortas="a-IcedTea-Web">IcedTea-Web</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to IcedTea-Web</title>

    <para>The <application>IcedTea-Web</application> package contains both a
    <application>Java</application> browser plugin, and a new webstart
    implementation, licensed under GPLV3.</para>

    &lfs82_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&icedtea-web-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&icedtea-web-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &icedtea-web-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &icedtea-web-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &icedtea-web-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &icedtea-web-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">IcedTea-Web Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="npapi-sdk"/>, and
      <xref linkend="openjdk"/> or
      <xref linkend="java"/> (remember to configure as described in the
      <xref linkend="ojdk-conf"/> page),
    </para>

    <bridgehead renderas="sect4">Required at runtime, a web browser,
    such as:</bridgehead>
    <para role="required">
      <xref role="runtime" linkend="epiphany"/> or
<!-- support removed in firefox-52, see https://support.mozilla.org/en-US/kb/npapi-plugins      <xref linkend="firefox"/>,
      <xref role="runtime" linkend="midori"/>, or -->
      <xref role="runtime" linkend="seamonkey"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="libxslt"/>,
      <xref linkend="mercurial"/>,
      <ulink url="http://emma.sourceforge.net/">EMMA</ulink>, and
      <ulink url="http://www.eclemma.org/jacoco/">JACOCO</ulink>
    </para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of IcedTea-Web</title>

    <para>Install <application>IcedTea-Web</application> by running the
    following commands:</para>

<screen><userinput>./configure --prefix=${JAVA_HOME}/jre    \
            --with-jdk-home=${JAVA_HOME} \
            --disable-docs               \
            --mandir=${JAVA_HOME}/man &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</para>

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

<screen role="root"><userinput>make install</userinput></screen>
<!-- mandb should not be in installation, rather in configuration. If
     the JAVA environment is configured as per the book, just running
     mandb should update the whatis database with anything in ${JAVA_HOME}/man.
     We do not have a mandb command in other pacakges.
mandb -c ${JAVA_HOME}/man</userinput></screen>-->

    <para>To test the man pages are correctly installed, issue <command>man policyeditor</command> to display the respective man page.</para>

    <para>If desired, you may install a .desktop file corresponding to an entry in a desktop menu for <command>policyeditor</command>, as <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>install -v -Dm0644 itweb-settings.desktop /usr/share/applications/itweb-settings.desktop &amp;&amp;
install -v -Dm0644 javaws.png /usr/share/pixmaps/javaws.png</userinput></screen>

  </sect2>

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

    <para><parameter>--with-jdk-home</parameter>: This switch provides the
    location of the installed <application>JDK</application>.</para>

    <para><parameter>--disable-docs</parameter>: This switch disables
    installation of additional developer-related documentation. Omit this
    switch if you would like to do development work on
    <application>IcedTea-Web</application>.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuration Information</title>

    <para>As the <systemitem class="username">root</systemitem> user, create a
    symbolic link to the plugin from your browser(s) plugins directory.
    For example, for <xref linkend="seamonkey"/>:</para>

<screen role="root"><userinput>install -dm755 /usr/lib/mozilla/plugins &amp;&amp;
ln -s ${JAVA_HOME}/jre/lib/IcedTeaPlugin.so /usr/lib/mozilla/plugins/</userinput></screen>

    <important>
      <para>The plugin must be a symlink for it to work. If not, the browsers
      will crash when you attempt to load a <application>Java</application>
      application.</para>
    </important>

  </sect2>

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

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


      <seglistitem>
        <seg>itweb-settings, javaws, and policyeditor</seg>
        <seg>IcedTeaPlugin.so, jsobject.jar, netx.jar, plugin.jar</seg>
        <seg>${JAVA_HOME}/jre/share/icedtea-web</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="itweb-settings">
        <term><command>itweb-settings</command></term>
        <listitem>
          <para>allows customization of the browser plugin and
          <application>javaws</application>.</para>
          <indexterm zone="icedtea-web itweb-settings">
            <primary sortas="b-itweb-settings">itweb-settings</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="javaws-itweb">
        <term><command>javaws</command></term>
        <listitem>
          <para>launches Java application/applets hosted on a network.</para>
          <indexterm zone="icedtea-web javaws-itweb">
            <primary sortas="b-javaws">javaws</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="policyeditor-itweb">
        <term><command>policyeditor</command></term>
        <listitem>
          <para>view and modify security policy settings, including
          certificates, for javaws and the browser plugin.</para>
          <indexterm zone="icedtea-web policyeditor-itweb">
            <primary sortas="b-policyeditor">policyeditor</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="IcedTeaPlugin">
        <term><filename class='libraryfile'>IcedTeaPlugin.so</filename></term>
        <listitem>
          <para>is the <application>Java</application> browser plugin.</para>
          <indexterm zone="icedtea-web IcedTeaPlugin">
            <primary sortas="c-IcedTeaPlugin">IcedTeaPlugin.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="jsobjectjar">
        <term><filename class='libraryfile'>jsobject.jar</filename></term>
        <listitem>
          <para>contains functions to manipulate JavaScript objects from
          JAVA code.</para>
          <indexterm zone="icedtea-web jsobjectjar">
            <primary sortas="c-jsobjectjar">jsobject.jar</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="netxjar">
        <term><filename class='libraryfile'>netx.jar</filename></term>
        <listitem>
          <para>contains functions for the
          <application>IcedTea-Web</application>
          webstart implementation (NetX).</para>
          <indexterm zone="icedtea-web netxjar">
            <primary sortas="c-netxjar">netx.jar</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pluginjar">
        <term><filename class='libraryfile'>plugin.jar</filename></term>
        <listitem>
          <para>contains functions for the
          <application>IcedTea-Web</application>
          <application>Java</application> plugin.</para>
          <indexterm zone="icedtea-web pluginjar">
            <primary sortas="c-pluginjar">plugin.jar</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>