source: gnome/platform/gjs.xml@ 6c378f6

<?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.76/gjs-&gjs-version;.tar.xz">
  <!ENTITY gjs-download-ftp  "&gnome-download-ftp;/gjs/1.76/gjs-&gjs-version;.tar.xz">
  <!ENTITY gjs-md5sum        "190ddbd9e98aa42c7a1f14b511427ff5">
  <!ENTITY gjs-size          "632 KB">
  <!ENTITY gjs-buildsize     "236 MB (with tests)">
  <!ENTITY gjs-time          "0.5 SBU (with tests)">
]>

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


  <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>

    &lfs113_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="js102"/>
    </para>

    <bridgehead renderas="sect4">Recommended (required for GNOME)</bridgehead>
    <para role="recommended">
      <xref linkend="gtk3"/> and
      <xref linkend="gtk4"/>
    </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://github.com/linux-test-project/lcov">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>
      Install <application>Gjs</application> by running the following
      commands:
    </para>

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

meson setup --prefix=/usr          \
            --buildtype=release    \
            --wrap-mode=nofallback \
            ..                     &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>. The
      <application>Gtk4</application> test iis known to fail. 
    </para>

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

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

  </sect2>

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

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-buildtype-release.xml"/>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-wrap-nofallback.xml"/>

    <para>
      <option>-Dprofiler=disabled</option>: prevents building the profiler
      backend even if <xref linkend="sysprof"/> is installed.
    </para>

  </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>