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