source: general/graphlib/glm.xml@ 2dc27593

<?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 glm-download-http "https://github.com/g-truc/glm/archive/&glm-version;/glm-&glm-version;.tar.gz">
  <!ENTITY glm-download-ftp  " ">
  <!ENTITY glm-md5sum        "e06e859bd80c5d6042f5c53630f385ec">
  <!ENTITY glm-size          "4.4 MB">
  <!ENTITY glm-buildsize     "50 MB">
  <!ENTITY glm-time          "0.8 SBU">
]>

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

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

  <title>GLM-&glm-version;</title>

  <indexterm zone="glm">
    <primary sortas="a-GLM">GLM</primary>
  </indexterm>

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

    <para>
      OpenGL Mathematics (<application>GLM</application>) is a header-only C++
      mathematics library for graphics software based on the OpenGL Shading
      Language (GLSL) specifications. An extension system provides extended
      capabilities such as matrix transformations and quaternions.
    </para>

    &lfs84_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&glm-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&glm-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &glm-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &glm-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &glm-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &glm-time;
        </para>
      </listitem>
    </itemizedlist>
<!--
    <note>
      <para>
        The <application>GLM</application> source tarball shown above
        downloads with the correct name, glm-&glm-version;.tar.gz, if
        using a browser such as Firefox. If you prefer to use a command line
        program such as wget, you normally would obtain &glm-version;.tar.gz.
        To obtain this package with the proper filename, run:

<screen><userinput>wget -c https://github.com/g-truc/glm/archive/&glm-version;.tar.gz \
     -O glm-&glm-version;.tar.gz</userinput></screen>
        </para>
      </note>
-->
    <bridgehead renderas="sect3">GLM Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cmake"/>
    </para>

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

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

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

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

cmake -DCMAKE_INSTALL_PREFIX=/usr   \
      -DCMAKE_INSTALL_LIBDIR=lib .. &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make test</command>.
    </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>
      <command>-DCMAKE_INSTALL_LIBDIR=lib ..</command>: Although no compiled
      libraries are installed, this command ensures that the
      <application>cmake</application> and
      <application>pkg-config</application> files are installed into
      <filename class="directory">/usr/lib</filename>.
    </para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          None.
        </seg>
        <seg>
          None.
        </seg>
        <seg>
          /usr/include/glm.
        </seg>
      </seglistitem>
    </segmentedlist>

    <!-- this package has no programs or libraries to describe -->

  </sect2>
</sect1>