source: general/genlib/js60.xml@ ca90d89

<?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 js60-download-http "http://ftp.gnome.org/pub/gnome/teams/releng/tarballs-needing-help/mozjs/mozjs-&JS60-version;.tar.bz2">
  <!ENTITY js60-download-ftp  "ftp://ftp.gnome.org/pub/gnome/teams/releng/tarballs-needing-help/mozjs/mozjs-&JS60-version;.tar.bz2">
  <!ENTITY js60-md5sum        "5eda38cc08a3594a3f2c3cc185d4f15b">
  <!ENTITY js60-size          "31 MB">
  <!ENTITY js60-buildsize     "640 MB"> <!-- The buildsize is over 4GB! Actually installed is much smaller. -->
  <!ENTITY js60-time          "6.6 SBU">
]>

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

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

  <title>JS-&JS60-version;</title>

  <indexterm zone="js60">
    <primary sortas="a-js60">js60</primary>
  </indexterm>

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

    <para>
      <application>JS</application> is Mozilla's JavaScript engine
      written in C. This package is present for GJS.
    </para>

    &lfs84_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&js60-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&js60-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &js60-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &js60-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &js60-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &js60-time;
        </para>
      </listitem>
    </itemizedlist>
<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/js60-&JS60-version;-security_fix-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>
-->
    <bridgehead renderas="sect3">JS60 Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="autoconf213"/>,
      <xref linkend="icu"/>,
      <xref linkend="python2"/>,
      <xref linkend="xorg7-lib"/>,
      <!--<xref linkend="yasm"/>,--> and
      <xref linkend="zip"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/>
    </para>

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

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

    <caution>
      <para>If you are upgrading JS60 from a previously installed old version,
      save all work and exit your GNOME Session if you have one running.
      Replacing the JS60 binary will cause the GNOME Shell to crash and return
      you to your display manager or TTY. After installing the new version,
      reinstall <xref linkend="gjs"/>. Polkit is unaffected.</para>
    </caution>
<!--
    <para>
      First, apply a security patch:
    </para>

<screen><userinput remap="pre">patch -Np1 -i ../js60-&JS60-version;-security_fix-1.patch</userinput></screen>
-->
    <para>
      Install <application>JS</application> by running the following
      commands:
    </para>

    &shell-env;

<screen><userinput>mkdir mozjs-build &amp;&amp;
cd    mozjs-build &amp;&amp;

../js/src/configure --prefix=/usr       \
                    --with-intl-api     \
                    --with-system-zlib  \
                    --with-system-icu   \
                    --disable-jemalloc  \
                    --enable-readline   &amp;&amp;
make</userinput></screen>

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

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

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

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

    <para>
      <parameter>--with-*</parameter>: These parameters allow the build system
      to use system versions of the above libriares. These are required for
      stability.
    </para>

    <para>
      <parameter>--enable-readline</parameter>: This switch enables Readline
      support in the JS shell.
    </para>
    
    <para>
      <parameter>--disable-jemalloc</parameter>: This switch disables the
      internal memory allocator used in JS60. jemalloc causes a conflict with glibc.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          js60 and js60-config
        </seg>
        <seg>
          libmozjs-60.so and libjs_static.ajs <!-- The AJS file doesn't
          conflict with the one from js52 like originally thought -->
        </seg>
        <seg>
          /usr/include/mozjs-60
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="js6-js60">
        <term><command>js60</command></term>
        <listitem>
          <para>
            provides a command line interface to the
            <application>JavaScript</application> engine.
          </para>
          <indexterm zone="js60 js60">
            <primary sortas="b-js60">js60</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="js60-config">
        <term><command>js60-config</command></term>
        <listitem>
          <para>
            is used to find the JS compiler and linker flags.
          </para>
          <indexterm zone="js60 js60-config">
            <primary sortas="b-js60-config">js60-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libmozjs-60">
        <term><filename class="libraryfile">libmozjs-60.so</filename></term>
        <listitem>
          <para>
            contains the Mozilla JavaScript API functions.
          </para>
          <indexterm zone="js60 libmozjs-60">
            <primary sortas="c-libmozjs60">libmozjs-60.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>