source: networking/netlibs/libslirp.xml@ 10af883

<?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 libslirp-download-http "https://gitlab.freedesktop.org/slirp/libslirp/-/archive/v&libslirp-version;/libslirp-v&libslirp-version;.tar.bz2">
  <!ENTITY libslirp-download-ftp  " ">
  <!ENTITY libslirp-md5sum        "b815c4de99265559caf5ef635a213609">
  <!ENTITY libslirp-size          "107 KB">
  <!ENTITY libslirp-buildsize     "3.1 MB">
  <!ENTITY libslirp-time          "less than 0.1 SBU">
]>

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

  <title>Libslirp-&libslirp-version;</title>

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

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

    <para>
      <application>Libslirp</application> is a user-mode networking library
      used by virtual machines, containers or various tools.
    </para>

    &lfs113_checked;

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

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

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

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

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

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

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

meson setup --prefix=/usr --buildtype=release .. &amp;&amp;

ninja</userinput></screen>

    <para>
      This package does not come with a test suite.
    </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>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-buildtype-release.xml"/>
  </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>
          libslirp.so
        </seg>
        <seg>
          /usr/include/slirp
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libslirp-lib">
        <term><filename class="libraryfile">libclirp.so</filename></term>
        <listitem>
          <para>
            contains user-mode TCP-IP emulation functions
          </para>
          <indexterm zone="libslirp libslirp-lib">
            <primary sortas="c-libslirp">libslirp.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>