source: general/graphlib/babl.xml@ 0bd02907

<?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 babl-download-http "https://download.gimp.org/pub/babl/0.1/babl-&babl-version;.tar.xz">
  <!ENTITY babl-download-ftp  " ">
  <!ENTITY babl-md5sum        "749169721b551882332a64ac17735de6">
  <!ENTITY babl-size          "312 KB">
  <!ENTITY babl-buildsize     "13 MB (with tests)">
  <!ENTITY babl-time          "0.1 SBU (Using parallelism=4; with tests)">
]>

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


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

  <indexterm zone="babl">
    <primary sortas="a-Babl">Babl</primary>
  </indexterm>

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

    <para>
      The <application>Babl</application> package is a dynamic, any to any,
      pixel format translation library.
    </para>

    &lfs121_checked;

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

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

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/> and
      <xref linkend="librsvg"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="lcms2"/> and
      <ulink url="&w3m-url;">w3m</ulink>
    </para>

  </sect2>

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

<!--
    <para>
      First, fix a typo that causes Meson to fail to run:
    </para>

<screen><userinput remap="pre">sed -i '/check:/d' meson.build</userinput></screen>
-->

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

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

meson setup --prefix=/usr --buildtype=release .. &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 &amp;&amp;

install -v -m755 -d                         /usr/share/gtk-doc/html/babl/graphics &amp;&amp;
install -v -m644 docs/*.{css,html}          /usr/share/gtk-doc/html/babl          &amp;&amp;
install -v -m644 docs/graphics/*.{html,svg} /usr/share/gtk-doc/html/babl/graphics</userinput></screen>
  </sect2>

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

    <para>
      <command>install -v -m755 -d
      /usr/share/gtk-doc/html/babl/graphics</command>: This and the subsequent
      commands install the library html documentation under
      <filename class="directory">/usr/share/gtk-doc/html</filename> where
      other gtk packages put the programmer-oriented 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>libbabl-0.1.so and libraries in /usr/lib/babl-0.1</seg>
        <seg>
          /usr/{include,lib}/babl-0.1 and
          /usr/share/gtk-doc/html/babl
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libbabl">
        <term><filename class="libraryfile">libbabl-0.1.so</filename></term>
        <listitem>
          <para>
            contains functions to access BablFishes to convert between formats
          </para>
          <indexterm zone="babl libbabl">
            <primary sortas="c-libbabl">libbabl-0.1.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>

</sect1>