source: x/lib/libepoxy.xml@ 96772841

<?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 libepoxy-download-http "https://github.com/anholt/libepoxy/releases/download/&libepoxy-version;/libepoxy-&libepoxy-version;.tar.xz">
  <!ENTITY libepoxy-download-ftp  " ">
  <!ENTITY libepoxy-md5sum        "8cbbf1809c3ec3063624939820e7b522">
  <!ENTITY libepoxy-size          "217 KB">
  <!ENTITY libepoxy-buildsize     "20 MB (with tests)">
  <!ENTITY libepoxy-time          "0.1 SBU (with tests)">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

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

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

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

    <para>
      <application>libepoxy</application> is a library for handling OpenGL
      function pointer management.
    </para>

    &lfs101_checked;

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

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/> (for documentation)
    </para>

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

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

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

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

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

    <para>
      To test the results, issue: <command>ninja test</command>.
    </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>

    <para>
      <option>-Ddocs=true</option>: If you have <xref linkend="doxygen"/>
      installed, add this option to generate additional documentation.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libepoxy.so
        </seg>
        <seg>
          /usr/include/epoxy
        </seg>
      </seglistitem>
    </segmentedlist>

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


      <varlistentry id="libepoxy-lib">
        <term><filename class="libraryfile">libepoxy.so</filename></term>
        <listitem>
          <para>
            contains API functions for handling OpenGL function
            pointer management
          </para>
          <indexterm zone="libepoxy libepoxy-lib">
            <primary sortas="c-libepoxy">libepoxy.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>