source: general/prog/cmake.xml@ b49cc97

<?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 cmake-download-http "http://www.cmake.org/files/v&cmake-major-version;/cmake-&cmake-version;.tar.gz">
  <!ENTITY cmake-download-ftp  " ">
  <!ENTITY cmake-md5sum        "801f4c87f8b604f727df5bf1f05a59e7">
  <!ENTITY cmake-size          "5.7 MB">
  <!ENTITY cmake-buildsize     "274 MB (including tests)">
  <!ENTITY cmake-time          "1.8 SBU (additional 6.5 SBU for the test suite)">
]>

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

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

  <title>CMake-&cmake-version;</title>

  <indexterm zone="cmake">
    <primary sortas="a-CMake">CMake</primary>
  </indexterm>

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

    <para>The <application>CMake</application> package contains a modern 
    toolset used for generating Makefiles. It is a successor of the 
    auto-generated <command>configure</command> script and aims to be platform-
    and compiler-independent. A significant user of 
    <application>CMake</application> is <application>KDE</application> since 
    version 4.</para>

    &lfs72_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="curl"/>, 
      <xref linkend="libarchive"/> and 
      <xref linkend="expat"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="subversion"/> (for testing) and
      <xref linkend="qt"/> (for the Qt-based GUI)
    </para>

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

  </sect2>

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

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

<screen><userinput>./bootstrap --prefix=/usr       \
            --system-libs       \
            --mandir=/share/man \
            --docdir=/share/doc/cmake-&cmake-version; &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <userinput>make test</userinput>.
    The SVN test may fail.</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>--system-libs</option>: This option forces the build system
    to link against <application>Zlib</application>, <application>Bzip2</application>, 
    <application>cURL</application> and <application>Expat</application> installed 
    on the system.</para>
    
    <para><option>--qt-gui</option>: This option builds a <application>Qt</application>-based 
    GUI for <application>CMake</application>.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>ccmake, cmake, cmake-gui, cpack and ctest</seg>
        <seg>none</seg>
        <seg>/usr/share/cmake-&cmake-major-version; and
        /usr/share/doc/cmake-&cmake-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="ccmake">
        <term><command>ccmake</command></term>
        <listitem>
          <para>is a curses based interactive frontend to cmake.</para>
          <indexterm zone="cmake ccmake">
            <primary sortas="b-ccmake">ccmake</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="c_make">
        <term><command>cmake</command></term>
        <listitem>
          <para>is the makefile generator.</para>
          <indexterm zone="cmake c_make">
            <primary sortas="b-cmake">cmake</primary>
          </indexterm>
        </listitem>
      </varlistentry>
      
      <varlistentry id="cmake-gui">
        <term><command>cmake-gui</command></term>
        <listitem>
          <para>is the Qt-based frontent to CMake.</para>
          <indexterm zone="cmake cmake-gui">
            <primary sortas="b-cmake-gui">cmake-gui</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="cpack">
        <term><command>cpack</command></term>
        <listitem>
          <para>is the CMake packaging program.</para>
          <indexterm zone="cmake cpack">
            <primary sortas="b-cpack">cpack</primary>
          </indexterm>
        </listitem>
      </varlistentry>      
      
      <varlistentry id="ctest">
        <term><command>ctest</command></term>
        <listitem>
          <para>is a testing utility for cmake-generated build trees.</para>
          <indexterm zone="cmake ctest">
            <primary sortas="b-ctest">ctest</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>