source: general/genlib/talloc.xml@ e7d893b

<?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 talloc-download-http "https://www.samba.org/ftp/talloc/talloc-&talloc-version;.tar.gz">
  <!ENTITY talloc-download-ftp  " ">
  <!ENTITY talloc-md5sum        "b60781acc2fb42d7a1e08751e508d3df">
  <!ENTITY talloc-size          "620 KB">
  <!ENTITY talloc-buildsize     "9.5 MB (with tests)">
  <!ENTITY talloc-time          "0.4 SBU (with tests)">
]>

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

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

  <title>Talloc-&talloc-version;</title>

  <indexterm zone="talloc">
    <primary sortas="a-Talloc">Talloc</primary>
  </indexterm>

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

    <para>
      <application>Talloc</application> provides a hierarchical, reference
      counted memory pool system with destructors. It is the core memory
      allocator used in <application>Samba</application>.
    </para>

    &lfs84_checked;

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="DocBook"/>,
      <xref linkend="docbook-xsl"/> and
      <xref linkend="libxslt"/> (To generate man pages),
      <xref linkend="python2"/> (To build Python-2 module),
      <xref linkend="gdb"/>,
      <xref linkend="git"/>,
      <xref linkend="xfsprogs"/>,
      <xref linkend="libtirpc"/>, and
      <xref linkend="valgrind"/>
      <!-- These are all looked for at build time, but might not actually be used.-->
    </para>

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

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

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

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>
      To check the results, issue <command>make check</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>
      <option>--extra-python=PYTHON</option>: This switch enables building
      selected libraries for the specified additional version of Python
      (example: <option>--extra-python=/usr/bin/python2</option>).
    </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>
          libpytalloc-util.cpython-35m-x86-64-linux-gnu.so,
          libpytalloc-util.so,
          libtalloc.so,
          <!-- NOTE: The below is Optional now. -->
          talloc.so (Python-2 Module) and
          talloc.cpython-35m-x86_64-linux-gnu.so (Python-3 Module)
        </seg>
        <seg>
          None
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libtalloc">
        <term><filename class="libraryfile">libtalloc.so</filename></term>
        <listitem>
          <para>
            contains a replacement for the <application>Glibc</application>
            malloc function.
          </para>
          <indexterm zone="talloc libtalloc">
            <primary sortas="c-libtalloc">libtalloc.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>