source: gnome/platform/gjs.xml@ e83d3a5

<?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 gjs-download-http "&gnome-download-http;/gjs/1.66/gjs-&gjs-version;.tar.xz">
  <!ENTITY gjs-download-ftp  "&gnome-download-ftp;/gjs/1.66/gjs-&gjs-version;.tar.xz">
  <!ENTITY gjs-md5sum        "3c272f27a2ce18c82261698520b1147f">
  <!ENTITY gjs-size          "432 KB">
  <!ENTITY gjs-buildsize     "82 MB (with tests)">
  <!ENTITY gjs-time          "0.8 SBU (with tests)">
]>

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

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

  <title>Gjs-&gjs-version;</title>

  <indexterm zone="gjs">
    <primary sortas="a-Gjs">Gjs</primary>
  </indexterm>

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

    <para>
      <application>Gjs</application> is a set of Javascript bindings for
      <application>GNOME</application>.
    </para>

    &lfs10_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cairo"/>,
      <xref linkend="dbus"/>,
      <xref linkend="gobject-introspection"/>, and
      <xref linkend="js78"/>
    </para>

    <bridgehead renderas="sect4">Recommended (required for GNOME)</bridgehead>
    <para role="recommended">
      <xref linkend="gtk3"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="sysprof"/>,
      <xref linkend="valgrind"/> (for tests),
      <ulink url="http://dtrace.org/blogs/about">DTrace</ulink>,
      <ulink url="https://wiki.gnome.org/Projects/GTK/Roadmap/GTK4">GTK+-4</ulink>,
      <ulink url="http://ltp.sourceforge.net/coverage/lcov.php">LCOV</ulink>, and
      <ulink url="https://sourceware.org/systemtap">Systemtap</ulink>
    </para>

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

  <sect2 role="installation">
    <title>Installation of Gjs</title>
<!--
    <para>
      First, work around a bug in meson caused by support for Windows NT:
    </para>

         When scripting, 'ninja install' fails because the 'gjs' symlink is
         generated before 'gjs-console' is installed. This seems to be due
         to adding symbolic link support for Windows NT-based platforms.
         This shouldn't affect us, so let's create the symlink manually
         like we do in other packages.
         Invalid with 1.64.3. Make sure you don't have DESTDIR
         set, such as you'd do in an update script.

<screen><userinput remap="pre">sed -i '/symlink-gjs.py/s/^/#/g' meson.build</userinput></screen>-->

    <para>
      Install <application>Gjs</application> by running the following
      commands:
    </para>

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

meson --prefix=/usr .. &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>. The
      <application>GTK</application> and <application>Cairo</application>
      tests will fail if not running in an Xorg session. <!--Additionally, four
      tests are currently known to fail:
      <filename>gjs:C / API tests</filename>,
      <filename>gjs:JS / GIMarshalling</filename>,
      <filename>gjs:JS / Regress</filename>, and
      <filename>gjs:JS / Gtk3</filename>.-->
    </para>

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

<screen role="root"><userinput>ninja install &amp;&amp;
ln -sfv gjs-console /usr/bin/gjs</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>
          gjs (symlink) and gjs-console
        </seg>
        <seg>
          libgjs.so
        </seg>
        <seg>
          /usr/include/gjs-1.0,
          /usr/lib/gjs,
          /usr/libexec/installed-tests/gjs,
          /usr/share/gjs-1.0, and
          /usr/share/installed-tests/gjs
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gjs-console">
        <term><command>gjs-console</command></term>
        <listitem>
          <para>
            contains a console to run <application>JavaScript</application>
            commands.
          </para>
          <indexterm zone="gjs gjs-console">
            <primary sortas="b-gjs-console">gjs-console</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgjs">
        <term><filename class="libraryfile">libgjs.so</filename></term>
        <listitem>
          <para>
            contains the <application>GNOME</application> JavaScript bindings.
          </para>
          <indexterm zone="gjs libgjs">
            <primary sortas="c-libgjs">libgjs.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>