[57f7cfa] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8dfc5c3] | 7 | <!ENTITY cmake-download-http "https://cmake.org/files/v&cmake-major-version;/cmake-&cmake-version;.tar.gz">
|
---|
[57f7cfa] | 8 | <!ENTITY cmake-download-ftp " ">
|
---|
[941750ea] | 9 | <!ENTITY cmake-md5sum "b0d46fdcca030372f0a464146243e193">
|
---|
[f67f8cbc] | 10 | <!ENTITY cmake-size "9.5 MB">
|
---|
| 11 | <!ENTITY cmake-buildsize "342 MB (add 1.0 GB for tests)">
|
---|
[941750ea] | 12 | <!ENTITY cmake-time "2.0 SBU (add 3.1 SBU for tests, both using parallelism=4)">
|
---|
[57f7cfa] | 13 | ]>
|
---|
| 14 |
|
---|
[b7b6efc] | 15 | <sect1 id="cmake" xreflabel="CMake-&cmake-version;">
|
---|
[57f7cfa] | 16 | <?dbhtml filename="cmake.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
| 21 |
|
---|
| 22 | <title>CMake-&cmake-version;</title>
|
---|
| 23 |
|
---|
| 24 | <indexterm zone="cmake">
|
---|
| 25 | <primary sortas="a-CMake">CMake</primary>
|
---|
| 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
| 29 | <title>Introduction to CMake</title>
|
---|
| 30 |
|
---|
[b7b6efc] | 31 | <para>
|
---|
[0d7900a] | 32 | The <application>CMake</application> package contains a modern
|
---|
| 33 | toolset used for generating Makefiles. It is a successor of the
|
---|
[b7b6efc] | 34 | auto-generated <command>configure</command> script and aims to
|
---|
[0d7900a] | 35 | be platform- and compiler-independent. A significant user of
|
---|
[b7b6efc] | 36 | <application>CMake</application> is <application>KDE</application>
|
---|
| 37 | since version 4.
|
---|
| 38 | </para>
|
---|
[57f7cfa] | 39 |
|
---|
[8c415ea] | 40 | &lfs111_checked;
|
---|
[57f7cfa] | 41 |
|
---|
| 42 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 43 | <itemizedlist spacing="compact">
|
---|
| 44 | <listitem>
|
---|
[b7b6efc] | 45 | <para>
|
---|
| 46 | Download (HTTP): <ulink url="&cmake-download-http;"/>
|
---|
| 47 | </para>
|
---|
[57f7cfa] | 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
[b7b6efc] | 50 | <para>
|
---|
| 51 | Download (FTP): <ulink url="&cmake-download-ftp;"/>
|
---|
| 52 | </para>
|
---|
[57f7cfa] | 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
[b7b6efc] | 55 | <para>
|
---|
| 56 | Download MD5 sum: &cmake-md5sum;
|
---|
| 57 | </para>
|
---|
[57f7cfa] | 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
[b7b6efc] | 60 | <para>
|
---|
| 61 | Download size: &cmake-size;
|
---|
| 62 | </para>
|
---|
[57f7cfa] | 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
[b7b6efc] | 65 | <para>
|
---|
| 66 | Estimated disk space required: &cmake-buildsize;
|
---|
| 67 | </para>
|
---|
[57f7cfa] | 68 | </listitem>
|
---|
| 69 | <listitem>
|
---|
[b7b6efc] | 70 | <para>
|
---|
| 71 | Estimated build time: &cmake-time;
|
---|
| 72 | </para>
|
---|
[57f7cfa] | 73 | </listitem>
|
---|
| 74 | </itemizedlist>
|
---|
| 75 |
|
---|
[464d3fc] | 76 | <!--
|
---|
[cc64b232] | 77 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 78 | <itemizedlist spacing="compact">
|
---|
| 79 | <listitem>
|
---|
| 80 | <para>
|
---|
| 81 | Required patch:
|
---|
[79067e0] | 82 | <ulink url="&patch-root;/cmake-&cmake-version;-src_property_fix-1.patch"/>
|
---|
[cc64b232] | 83 | </para>
|
---|
| 84 | </listitem>
|
---|
| 85 | </itemizedlist>
|
---|
[464d3fc] | 86 | -->
|
---|
[cc64b232] | 87 |
|
---|
[57f7cfa] | 88 | <bridgehead renderas="sect3">CMake Dependencies</bridgehead>
|
---|
| 89 |
|
---|
[6eb166fa] | 90 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 91 | <para role="required">
|
---|
[8558044] | 92 | <xref linkend="libuv"/>
|
---|
[6eb166fa] | 93 | </para>
|
---|
| 94 |
|
---|
[e1b2c0e] | 95 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 96 | <para role="recommended">
|
---|
[cc64b232] | 97 | <xref linkend="curl"/>,
|
---|
| 98 | <xref linkend="libarchive"/>, and
|
---|
| 99 | <xref linkend="nghttp2"/>
|
---|
[b88be39] | 100 | </para>
|
---|
| 101 |
|
---|
[2bcddd4] | 102 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[b88be39] | 103 | <para role="optional">
|
---|
[0aa72821] | 104 | <xref linkend="gcc"/> (for gfortran),
|
---|
[f6308e8] | 105 | <xref linkend="git"/> (for use during tests),
|
---|
[bb31faa3] | 106 | <xref linkend="mercurial"/> (for use during tests),
|
---|
[67b1a0a1] | 107 | <xref linkend="qt5"/> (for the Qt-based GUI),
|
---|
[81a1bf31] | 108 | <xref linkend="subversion"/> (for testing),
|
---|
| 109 | <ulink url="http://rhash.sourceforge.net/">rhash</ulink>, and
|
---|
[3c7458ca] | 110 | <ulink url="https://pypi.python.org/pypi/Sphinx">Sphinx</ulink> (for building documents)
|
---|
[57f7cfa] | 111 | </para>
|
---|
| 112 |
|
---|
| 113 | <para condition="html" role="usernotes">User Notes:
|
---|
[b7b6efc] | 114 | <ulink url="&blfs-wiki;/cmake"/>
|
---|
| 115 | </para>
|
---|
[57f7cfa] | 116 | </sect2>
|
---|
| 117 |
|
---|
| 118 | <sect2 role="installation">
|
---|
| 119 | <title>Installation of CMake</title>
|
---|
[20c731a] | 120 |
|
---|
[464d3fc] | 121 | <!-- This patch might be included in 3.19.1 and higher
|
---|
[cc64b232] | 122 | <para>
|
---|
[79067e0] | 123 | First, fix a regression that was discovered after the release of 3.19.0:
|
---|
[cc64b232] | 124 | </para>
|
---|
| 125 |
|
---|
[79067e0] | 126 | <screen><userinput remap="pre">patch -Np1 -i ../cmake-&cmake-version;-src_property_fix-1.patch</userinput></screen>
|
---|
[464d3fc] | 127 | -->
|
---|
[cc64b232] | 128 |
|
---|
[b7b6efc] | 129 | <para>
|
---|
| 130 | Install <application>CMake</application> by running the following
|
---|
| 131 | commands:
|
---|
| 132 | </para>
|
---|
[57f7cfa] | 133 |
|
---|
[6eb166fa] | 134 | <screen><userinput>sed -i '/"lib64"/s/64//' Modules/GNUInstallDirs.cmake &&
|
---|
[f1ab71d] | 135 |
|
---|
[20c731a] | 136 | ./bootstrap --prefix=/usr \
|
---|
| 137 | --system-libs \
|
---|
| 138 | --mandir=/share/man \
|
---|
| 139 | --no-system-jsoncpp \
|
---|
| 140 | --no-system-librhash \
|
---|
[f3efa2c] | 141 | --docdir=/share/doc/cmake-&cmake-version; &&
|
---|
[57f7cfa] | 142 | make</userinput></screen>
|
---|
| 143 |
|
---|
[b7b6efc] | 144 | <para>
|
---|
[bc38b45] | 145 | To test the results, issue: <command>LC_ALL=en_US.UTF-8 bin/ctest
|
---|
[7ed0e9d] | 146 | -j<replaceable><N></replaceable> -O
|
---|
| 147 | cmake-&cmake-version;-test.log</command>, where
|
---|
[f3efa2c] | 148 | <replaceable><N></replaceable> is an integer between 1 and the
|
---|
[bc38b45] | 149 | number of system cores. Setting <envar>LC_ALL</envar> is needed to
|
---|
| 150 | prevent some test failures when some of the locale variables are
|
---|
[c4938ccc] | 151 | set to non English locales. One test, RunCMake.CMP0125, is known to fail.
|
---|
[2bbc6b0e] | 152 | </para>
|
---|
[2cd6717] | 153 |
|
---|
[8558044] | 154 | <para>
|
---|
[2bbc6b0e] | 155 | If you want to investigate a problem with a given "problem1-test",
|
---|
[248a536] | 156 | use <command>bin/ctest -R "problem1-test"</command> and, to omit it, use
|
---|
[369d7767] | 157 | <command>bin/ctest -E "problem1-test"</command>. These options can be
|
---|
[f72bfbe1] | 158 | used together:
|
---|
| 159 | <command>bin/ctest -R "problem1-test" -E "problem2-test"</command>.
|
---|
| 160 | Option <option>-N</option> can be used to display all
|
---|
[248a536] | 161 | available tests, and you can run <command>bin/ctest</command> for a
|
---|
| 162 | sub-set of tests by using separated by spaces names or numbers as
|
---|
[f72bfbe1] | 163 | options. Option <option>--help</option> can be used to show all options.
|
---|
[b7b6efc] | 164 | </para>
|
---|
[b88be39] | 165 |
|
---|
[b7b6efc] | 166 | <para>
|
---|
| 167 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 168 | </para>
|
---|
[57f7cfa] | 169 |
|
---|
| 170 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 171 |
|
---|
| 172 | </sect2>
|
---|
| 173 |
|
---|
| 174 | <sect2 role="commands">
|
---|
| 175 | <title>Command Explanations</title>
|
---|
| 176 |
|
---|
[87ff6f30] | 177 | <para>
|
---|
[8558044] | 178 | <command>sed ... Modules/GNUInstallDirs.cmake</command>:
|
---|
| 179 | This command disables applications using cmake from attempting to
|
---|
[0901194] | 180 | install files in /usr/lib64/.
|
---|
[87ff6f30] | 181 | </para>
|
---|
| 182 |
|
---|
[b7b6efc] | 183 | <para>
|
---|
[407637c] | 184 | <parameter>--system-libs</parameter>: This switch forces the build system
|
---|
| 185 | to link against <application>Zlib</application>,
|
---|
| 186 | <application>Bzip2</application>, <application>cURL</application>,
|
---|
[2e4d2f37] | 187 | <application>nghttp2</application>,
|
---|
[407637c] | 188 | <application>Expat</application> and <application>libarchive</application>
|
---|
| 189 | installed on the system.
|
---|
[b7b6efc] | 190 | </para>
|
---|
[0d7900a] | 191 |
|
---|
[2c38e951] | 192 | <para>
|
---|
| 193 | <parameter>--no-system-jsoncpp</parameter>: This switch removes the
|
---|
| 194 | <application>JSON-C++</application> library from the list of system
|
---|
| 195 | libraries. A bundled version of that library is used instead.
|
---|
[81a1bf31] | 196 | </para>
|
---|
| 197 |
|
---|
| 198 | <para>
|
---|
| 199 | <parameter>--no-system-librhash</parameter>: This switch removes the
|
---|
| 200 | <application>librhash</application> library from the list of system
|
---|
| 201 | libraries used. A bundled version of that library is used instead.
|
---|
[2c38e951] | 202 | </para>
|
---|
| 203 |
|
---|
[b7b6efc] | 204 | <para>
|
---|
[fa2c610] | 205 | <option>--qt-gui</option>: This switch enables building the
|
---|
[b7b6efc] | 206 | <application>Qt</application>-based GUI for
|
---|
| 207 | <application>CMake</application>.
|
---|
| 208 | </para>
|
---|
[57f7cfa] | 209 |
|
---|
[cc64b232] | 210 | <para>
|
---|
[8558044] | 211 | <option>--parallel=</option>: This switch enables performing the
|
---|
[cc64b232] | 212 | <application>CMake</application> bootstrap with multiple jobs
|
---|
| 213 | at one time.
|
---|
| 214 | </para>
|
---|
| 215 |
|
---|
[57f7cfa] | 216 | </sect2>
|
---|
| 217 |
|
---|
| 218 | <sect2 role="content">
|
---|
| 219 | <title>Contents</title>
|
---|
| 220 |
|
---|
| 221 | <segmentedlist>
|
---|
[fd27868] | 222 | <segtitle>Installed Programs</segtitle>
|
---|
[c3c56b2] | 223 | <segtitle>Installed Libraries</segtitle>
|
---|
[fd27868] | 224 | <segtitle>Installed Directories</segtitle>
|
---|
[57f7cfa] | 225 |
|
---|
| 226 | <seglistitem>
|
---|
[b7b6efc] | 227 | <seg>
|
---|
[6c6f393] | 228 | ccmake, cmake, cmake-gui (optional), cpack, and ctest
|
---|
[b7b6efc] | 229 | </seg>
|
---|
[c3c56b2] | 230 | <seg>
|
---|
| 231 | None
|
---|
| 232 | </seg>
|
---|
[b7b6efc] | 233 | <seg>
|
---|
| 234 | /usr/share/cmake-&cmake-major-version; and
|
---|
| 235 | /usr/share/doc/cmake-&cmake-version;
|
---|
| 236 | </seg>
|
---|
[57f7cfa] | 237 | </seglistitem>
|
---|
| 238 | </segmentedlist>
|
---|
| 239 |
|
---|
[0d7900a] | 240 |
|
---|
[57f7cfa] | 241 | <variablelist>
|
---|
| 242 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 243 | <?dbfo list-presentation="list"?>
|
---|
| 244 | <?dbhtml list-presentation="table"?>
|
---|
| 245 |
|
---|
| 246 | <varlistentry id="ccmake">
|
---|
| 247 | <term><command>ccmake</command></term>
|
---|
| 248 | <listitem>
|
---|
[b7b6efc] | 249 | <para>
|
---|
| 250 | is a curses based interactive frontend to
|
---|
[4c24eb0a] | 251 | <command>cmake</command>
|
---|
[b7b6efc] | 252 | </para>
|
---|
[57f7cfa] | 253 | <indexterm zone="cmake ccmake">
|
---|
| 254 | <primary sortas="b-ccmake">ccmake</primary>
|
---|
| 255 | </indexterm>
|
---|
| 256 | </listitem>
|
---|
| 257 | </varlistentry>
|
---|
| 258 |
|
---|
[b7b6efc] | 259 | <varlistentry id="cmake-prog">
|
---|
[57f7cfa] | 260 | <term><command>cmake</command></term>
|
---|
| 261 | <listitem>
|
---|
[b7b6efc] | 262 | <para>
|
---|
[4c24eb0a] | 263 | is the makefile generator
|
---|
[b7b6efc] | 264 | </para>
|
---|
| 265 | <indexterm zone="cmake cmake-prog">
|
---|
[57f7cfa] | 266 | <primary sortas="b-cmake">cmake</primary>
|
---|
| 267 | </indexterm>
|
---|
| 268 | </listitem>
|
---|
| 269 | </varlistentry>
|
---|
[0d7900a] | 270 |
|
---|
[2bcddd4] | 271 | <varlistentry id="cmake-gui">
|
---|
| 272 | <term><command>cmake-gui</command></term>
|
---|
| 273 | <listitem>
|
---|
[b7b6efc] | 274 | <para>
|
---|
[fa2c610] | 275 | (optional) is the <application>Qt</application>-based frontend to
|
---|
[4c24eb0a] | 276 | <command>cmake</command>
|
---|
[b7b6efc] | 277 | </para>
|
---|
[2bcddd4] | 278 | <indexterm zone="cmake cmake-gui">
|
---|
| 279 | <primary sortas="b-cmake-gui">cmake-gui</primary>
|
---|
| 280 | </indexterm>
|
---|
| 281 | </listitem>
|
---|
| 282 | </varlistentry>
|
---|
| 283 |
|
---|
| 284 | <varlistentry id="cpack">
|
---|
| 285 | <term><command>cpack</command></term>
|
---|
| 286 | <listitem>
|
---|
[b7b6efc] | 287 | <para>
|
---|
[4c24eb0a] | 288 | is the <application>CMake</application> packaging program
|
---|
[b7b6efc] | 289 | </para>
|
---|
[2bcddd4] | 290 | <indexterm zone="cmake cpack">
|
---|
| 291 | <primary sortas="b-cpack">cpack</primary>
|
---|
| 292 | </indexterm>
|
---|
| 293 | </listitem>
|
---|
[0d7900a] | 294 | </varlistentry>
|
---|
| 295 |
|
---|
[2bcddd4] | 296 | <varlistentry id="ctest">
|
---|
| 297 | <term><command>ctest</command></term>
|
---|
| 298 | <listitem>
|
---|
[b7b6efc] | 299 | <para>
|
---|
[4c24eb0a] | 300 | is a testing utility for cmake-generated build trees
|
---|
[b7b6efc] | 301 | </para>
|
---|
[2bcddd4] | 302 | <indexterm zone="cmake ctest">
|
---|
| 303 | <primary sortas="b-ctest">ctest</primary>
|
---|
| 304 | </indexterm>
|
---|
| 305 | </listitem>
|
---|
| 306 | </varlistentry>
|
---|
[57f7cfa] | 307 |
|
---|
| 308 | </variablelist>
|
---|
| 309 |
|
---|
| 310 | </sect2>
|
---|
| 311 |
|
---|
| 312 | </sect1>
|
---|