source: gnome/core/gjs.xml@ d171f893

<?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.30/gjs-&gjs-version;.tar.xz">
  <!ENTITY gjs-download-ftp  "&gnome-download-ftp;/gjs/1.30/gjs-&gjs-version;.tar.xz">
  <!ENTITY gjs-md5sum        "908c1c8654d141d64aac07d57de9a457">
  <!ENTITY gjs-size          "445 KB">
  <!ENTITY gjs-buildsize     "15 MB">
  <!ENTITY gjs-time          "0.3 SBU">
]>

<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 Javascript binding for
    <application>GNOME</application>.</para>

    &lfs70_built;

    <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-glib"/>, and
    <xref linkend="gobject-introspection"/>, and
    <xref linkend="SpiderMonkey"/></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>./configure --prefix=$GNOME_PREFIX &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.</para>

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

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

  </sect2>

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

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

      <seglistitem>
        <seg>gjs and gjs-console</seg>
        <seg>cairoNative.so, console.so, dbusNative.so, debugger.so, gettextNative.so, langNative.so, libgjs-dbus.so, libgjs-gdbus.so, libgjs.so, and mainloop.so</seg>
        <seg><envar>$GNOME_PREFIX</envar>/{include/gjs-1.0/{gi,gjs-dbus},lib/gjs-1.0,share/gjs-1.0/{overrides,tweener}}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gjs-prog">
        <term><command>gjs-prog</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="gjs gjs-prog">
            <primary sortas="b-gjs-prog">gjs-prog</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gjs-console">
        <term><command>gjs-console</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="gjs gjs-console">
            <primary sortas="b-gjs-console">gjs-console</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="cairoNative">
        <term><filename class='libraryfile'>cairoNative.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="gjs cairoNative">
            <primary sortas="c-cairoNative">cairoNative.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="console">
        <term><filename class='libraryfile'>console.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="gjs console">
            <primary sortas="c-console">console.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="dbusNative">
        <term><filename class='libraryfile'>dbusNative.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="gjs dbusNative">
            <primary sortas="c-dbusNative">dbusNative.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="debugger">
        <term><filename class='libraryfile'>debugger.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="gjs debugger">
            <primary sortas="c-debugger">debugger.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gettextNative">
        <term><filename class='libraryfile'>gettextNative.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="gjs gettextNative">
            <primary sortas="c-gettextNative">gettextNative.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="langNative">
        <term><filename class='libraryfile'>langNative.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="gjs langNative">
            <primary sortas="c-langNative">langNative.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgjs-dbus">
        <term><filename class='libraryfile'>libgjs-dbus.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="gjs libgjs-dbus">
            <primary sortas="c-libgjs-dbus">libgjs-dbus.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgjs-gdbus">
        <term><filename class='libraryfile'>libgjs-gdbus.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="gjs libgjs-gdbus">
            <primary sortas="c-libgjs-gdbus">libgjs-gdbus.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgjs">
        <term><filename class='libraryfile'>libgjs.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="gjs libgjs">
            <primary sortas="c-libgjs">libgjs.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="mainloop">
        <term><filename class='libraryfile'>mainloop.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="gjs mainloop">
            <primary sortas="c-mainloop">mainloop.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>