glfs/general/genlib/yaml.xml

<?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 yaml-download-http "https://github.com/yaml/libyaml/archive/&yaml-version;/yaml-&yaml-version;.tar.gz">
  <!ENTITY yaml-download-ftp  " ">
  <!ENTITY yaml-md5sum        "2ad4119a57f94739cc39a1b482c81264">
  <!ENTITY yaml-size          "80 KB">
  <!ENTITY yaml-buildsize     "3.0 MB (with tests)">
  <!ENTITY yaml-time          "less than 0.1 SBU (with tests)">
]>

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

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

  <title>YAML-&yaml-version;</title>

  <indexterm zone="yaml">
    <primary sortas="a-YAML">YAML</primary>
  </indexterm>

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

    <para>
      The <application>YAML</application> package contains a C
      library for parsing and emitting YAML (YAML Ain't Markup
      Language).
    </para>

    &lfs84_checked;

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/>
    </para>

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

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

    <note>
      <para>This package expands to libyaml-&yaml-version;, not
      the expected yaml-&yaml-version;.</para>
    </note>

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

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

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DBUILD_SHARED_LIBS=true    \
      -DCMAKE_BUILD_TYPE=RELEASE ..  &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>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

  </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>
          libyaml.so
        </seg>
        <seg>
          None
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libyaml">
        <term><filename class="libraryfile">libyaml.so</filename></term>
        <listitem>
          <para>
            contains API functions for parsing and emitting YAML.
          </para>
          <indexterm zone="yaml libyaml">
            <primary sortas="c-libyaml">libyaml.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>