source: general/prog/luajit.xml@ f65e42d

<?xml version="1.0" encoding="UTF-8"?>
<!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 luajit-download-http "&sources-anduin-http;/luajit/luajit-&luajit-version;.tar.xz">
  <!ENTITY luajit-md5sum        "6f4dff26fee2904de445b575e82a8815">
  <!ENTITY luajit-size          "728 KB">
  <!ENTITY luajit-buildsize     "12 MB">
  <!ENTITY luajit-time          "0.3 SBU">
]>

<sect1 id="luajit" xreflabel="luajit-&luajit-version;">
  <?dbhtml filename="luajit"?>

  <title>luajit-&luajit-version;</title>

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

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

    <para>
      The <application>luajit</application> package contains a Just-In-Time
      compiler for Lua. It is often used as scripting middleware, and it is
      high performance while also having a low memory footprint.
    </para>

    &lfs122_checked;

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

    <!-- LuaJIT has no dependencies other than GCC. -->

  </sect2>

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

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

<!-- We need to specify PREFIX=/usr here so it loads plugins from
     /usr/lib/luajit instead of /usr/local/lib/luajit. -->

<screen><userinput>make PREFIX=/usr</userinput></screen>

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

    <para>
      Now, as the &root; user:
    </para>

<screen role="root"><userinput>make PREFIX=/usr install &amp;&amp;
rm -v /usr/lib/libluajit-5.1.a</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>
          luajit (symlink to luajit-2.1.ROLLING) and
          luajit-2.1.ROLLING
        </seg>
        <seg>
          libluajit-5.1.so
        </seg>
        <seg>
          /usr/include/luajit-2.1 and
          /usr/share/luajit-2.1
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="luajit-prog">
        <term><command>luajit</command></term>
        <listitem>
          <para>
            provides a Just-In-Time compiler for Lua
          </para>
          <indexterm zone="luajit luajit-prog">
            <primary sortas="b-luajit">luajit</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libluajit-5.1">
        <term><filename class="libraryfile">libluajit-5.1.so</filename></term>
        <listitem>
          <para>
            contains an API for the Just-In-Time compiler for Lua
          </para>
          <indexterm zone="luajit libluajit-5.1">
            <primary sortas="c-libluajit-5.1">libluajit-5.1.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>