source: general/genlib/libsigc++.xml@ 23ce4179

<?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 libsigc-download-http "&gnome-download-http;/libsigc++/2.10/libsigc++-&libsigc-version;.tar.xz">
  <!ENTITY libsigc-download-ftp  "&gnome-download-ftp;/libsigc++/2.10/libsigc++-&libsigc-version;.tar.xz">
  <!ENTITY libsigc-md5sum        "34fdf5910c32763e5fbe61ac2a37cec2">
  <!ENTITY libsigc-size          "4.6 MB">
  <!ENTITY libsigc-buildsize     "39 MB (with tests)">
  <!ENTITY libsigc-time          "0.2 SBU (with tests)">
]>

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

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

  <title>libsigc++-&libsigc-version;</title>

  <indexterm zone="libsigc">
    <primary sortas="a-libsigc++">libsigc++</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libsigc++</title>

    <para>
      The <application>libsigc++</application> package implements a typesafe
      callback system for standard C++.
    </para>

    &lfs10_checked;

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

    <bridgehead renderas="sect3">libsigc++ Dependencies</bridgehead>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="boost"/> and
      <xref linkend="libxslt"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="docbook-utils"/>,
      <xref linkend="doxygen"/>, and
      <ulink url="&gnome-download-http;/mm-common">mm-common</ulink>
    </para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of libsigc++</title>

<!--
    <para>
      First, fix the documentation directory name:
    </para>

<screen><userinput>sed -e '/^libdocdir =/ s/$(book_name)/libsigc++-&libsigc-version;/' -i docs/Makefile.in</userinput></screen>
-->

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

<screen><userinput>mkdir bld &amp;&amp;
cd    bld &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>-Dbuild_documentation=true</option>: Use this switch if
      <xref role="nodep" linkend="doxygen"/> is installed and you wish to
      build and install the API documentation.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libsigc-2.0.so
        </seg>
        <seg>
          /usr/{include,lib}/sigc++-2.0 and
          /usr/share/{devhelp/books,doc}/libsigc++-2.0 (if the documentation is enabled)
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libsigc-2">
        <term><filename class="libraryfile">libsigc-2.0.so</filename></term>
        <listitem>
          <para>
            contains the <application>libsigc++</application> API functions.
          </para>
          <indexterm zone="libsigc libsigc-2">
            <primary sortas="c-libsigc-2">libsigc-2.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>