[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[57f7cfa] | 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 " ">
|
---|
[f5e81d6f] | 9 | <!ENTITY cmake-md5sum "fd4bc3f35bf7e5ae9f96b9b51f835432">
|
---|
[f64aab6] | 10 | <!ENTITY cmake-size "11 MB">
|
---|
[6f5feb1] | 11 | <!ENTITY cmake-buildsize "462 MB (add 1.3 GB for tests)">
|
---|
| 12 | <!ENTITY cmake-time "2.0 SBU (add 4.0 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 |
|
---|
| 19 | <title>CMake-&cmake-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="cmake">
|
---|
| 22 | <primary sortas="a-CMake">CMake</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to CMake</title>
|
---|
| 27 |
|
---|
[b7b6efc] | 28 | <para>
|
---|
[0d7900a] | 29 | The <application>CMake</application> package contains a modern
|
---|
| 30 | toolset used for generating Makefiles. It is a successor of the
|
---|
[b7b6efc] | 31 | auto-generated <command>configure</command> script and aims to
|
---|
[0d7900a] | 32 | be platform- and compiler-independent. A significant user of
|
---|
[b7b6efc] | 33 | <application>CMake</application> is <application>KDE</application>
|
---|
| 34 | since version 4.
|
---|
| 35 | </para>
|
---|
[57f7cfa] | 36 |
|
---|
[e375445] | 37 | &lfs122_checked;
|
---|
[57f7cfa] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
[b7b6efc] | 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&cmake-download-http;"/>
|
---|
| 44 | </para>
|
---|
[57f7cfa] | 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
[b7b6efc] | 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&cmake-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
[57f7cfa] | 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
[b7b6efc] | 52 | <para>
|
---|
| 53 | Download MD5 sum: &cmake-md5sum;
|
---|
| 54 | </para>
|
---|
[57f7cfa] | 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
[b7b6efc] | 57 | <para>
|
---|
| 58 | Download size: &cmake-size;
|
---|
| 59 | </para>
|
---|
[57f7cfa] | 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
[b7b6efc] | 62 | <para>
|
---|
| 63 | Estimated disk space required: &cmake-buildsize;
|
---|
| 64 | </para>
|
---|
[57f7cfa] | 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
[b7b6efc] | 67 | <para>
|
---|
| 68 | Estimated build time: &cmake-time;
|
---|
| 69 | </para>
|
---|
[57f7cfa] | 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
| 72 |
|
---|
[498e62a] | 73 | <!--
|
---|
[cc64b232] | 74 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
| 75 | <itemizedlist spacing="compact">
|
---|
| 76 | <listitem>
|
---|
| 77 | <para>
|
---|
| 78 | Required patch:
|
---|
[dca2b43e] | 79 | <ulink url="&patch-root;/cmake-&cmake-version;-upstream_fix-1.patch"/>
|
---|
[cc64b232] | 80 | </para>
|
---|
| 81 | </listitem>
|
---|
| 82 | </itemizedlist>
|
---|
[498e62a] | 83 | -->
|
---|
[cc64b232] | 84 |
|
---|
[57f7cfa] | 85 | <bridgehead renderas="sect3">CMake Dependencies</bridgehead>
|
---|
| 86 |
|
---|
[e1b2c0e] | 87 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 88 | <para role="recommended">
|
---|
[cc64b232] | 89 | <xref linkend="curl"/>,
|
---|
[d2c16a45] | 90 | <xref linkend="libarchive"/>,
|
---|
| 91 | <xref linkend="libuv"/>, and
|
---|
[cc64b232] | 92 | <xref linkend="nghttp2"/>
|
---|
[b88be39] | 93 | </para>
|
---|
| 94 |
|
---|
[2bcddd4] | 95 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[b88be39] | 96 | <para role="optional">
|
---|
[0aa72821] | 97 | <xref linkend="gcc"/> (for gfortran),
|
---|
[f6308e8] | 98 | <xref linkend="git"/> (for use during tests),
|
---|
[bb31faa3] | 99 | <xref linkend="mercurial"/> (for use during tests),
|
---|
[63a2e838] | 100 | <xref linkend="openjdk"/> (for use during tests),
|
---|
[5866da0] | 101 | <xref linkend="qt6"/> (for the Qt-based GUI),
|
---|
[c10acfe] | 102 | <xref linkend="sphinx"/> (for building documents),
|
---|
[3a001df8] | 103 | <xref linkend="subversion"/> (for testing),
|
---|
| 104 | <ulink url="https://github.com/google/cppdap/">cppdap</ulink>,
|
---|
| 105 | <ulink url="https://github.com/open-source-parsers/jsoncpp/">jsoncpp</ulink>, and
|
---|
[17aa21c] | 106 | <ulink url="https://rhash.sourceforge.net/">rhash</ulink>
|
---|
[57f7cfa] | 107 | </para>
|
---|
| 108 |
|
---|
| 109 | </sect2>
|
---|
| 110 |
|
---|
| 111 | <sect2 role="installation">
|
---|
| 112 | <title>Installation of CMake</title>
|
---|
[20c731a] | 113 |
|
---|
[498e62a] | 114 | <!--
|
---|
[cc64b232] | 115 | <para>
|
---|
[dca2b43e] | 116 | First, adapt the FindBoost module to use Boost-1.80.0:
|
---|
[cc64b232] | 117 | </para>
|
---|
| 118 |
|
---|
[dca2b43e] | 119 | <screen><userinput remap="pre">patch -Np1 -i ../cmake-&cmake-version;-upstream_fix-1.patch</userinput></screen>
|
---|
[498e62a] | 120 | -->
|
---|
[cc64b232] | 121 |
|
---|
[b7b6efc] | 122 | <para>
|
---|
| 123 | Install <application>CMake</application> by running the following
|
---|
| 124 | commands:
|
---|
| 125 | </para>
|
---|
[57f7cfa] | 126 |
|
---|
[6eb166fa] | 127 | <screen><userinput>sed -i '/"lib64"/s/64//' Modules/GNUInstallDirs.cmake &&
|
---|
[f1ab71d] | 128 |
|
---|
[20c731a] | 129 | ./bootstrap --prefix=/usr \
|
---|
| 130 | --system-libs \
|
---|
| 131 | --mandir=/share/man \
|
---|
| 132 | --no-system-jsoncpp \
|
---|
[5699c638] | 133 | --no-system-cppdap \
|
---|
[20c731a] | 134 | --no-system-librhash \
|
---|
[f3efa2c] | 135 | --docdir=/share/doc/cmake-&cmake-version; &&
|
---|
[57f7cfa] | 136 | make</userinput></screen>
|
---|
| 137 |
|
---|
[b7b6efc] | 138 | <para>
|
---|
[bc38b45] | 139 | To test the results, issue: <command>LC_ALL=en_US.UTF-8 bin/ctest
|
---|
[7ed0e9d] | 140 | -j<replaceable><N></replaceable> -O
|
---|
| 141 | cmake-&cmake-version;-test.log</command>, where
|
---|
[f3efa2c] | 142 | <replaceable><N></replaceable> is an integer between 1 and the
|
---|
[bc38b45] | 143 | number of system cores. Setting <envar>LC_ALL</envar> is needed to
|
---|
| 144 | prevent some test failures when some of the locale variables are
|
---|
[e440af5] | 145 | set to non English locales.
|
---|
[5699c638] | 146 | <!--
|
---|
| 147 | One test, RunCMake.FindBoost, is known to fail.
|
---|
| 148 | Now cmake-3.27.0. All tests pass.
|
---|
| 149 | -->
|
---|
[2bbc6b0e] | 150 | </para>
|
---|
[2cd6717] | 151 |
|
---|
[8558044] | 152 | <para>
|
---|
[2bbc6b0e] | 153 | If you want to investigate a problem with a given "problem1-test",
|
---|
[248a536] | 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
|
---|
[f72bfbe1] | 156 | used together:
|
---|
| 157 | <command>bin/ctest -R "problem1-test" -E "problem2-test"</command>.
|
---|
| 158 | Option <option>-N</option> can be used to display all
|
---|
[248a536] | 159 | available tests, and you can run <command>bin/ctest</command> for a
|
---|
| 160 | sub-set of tests by using separated by spaces names or numbers as
|
---|
[f72bfbe1] | 161 | options. Option <option>--help</option> can be used to show all options.
|
---|
[b7b6efc] | 162 | </para>
|
---|
[b88be39] | 163 |
|
---|
[b7b6efc] | 164 | <para>
|
---|
| 165 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 166 | </para>
|
---|
[57f7cfa] | 167 |
|
---|
| 168 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 169 |
|
---|
| 170 | </sect2>
|
---|
| 171 |
|
---|
| 172 | <sect2 role="commands">
|
---|
| 173 | <title>Command Explanations</title>
|
---|
| 174 |
|
---|
[87ff6f30] | 175 | <para>
|
---|
[8558044] | 176 | <command>sed ... Modules/GNUInstallDirs.cmake</command>:
|
---|
| 177 | This command disables applications using cmake from attempting to
|
---|
[0901194] | 178 | install files in /usr/lib64/.
|
---|
[87ff6f30] | 179 | </para>
|
---|
| 180 |
|
---|
[b7b6efc] | 181 | <para>
|
---|
[9c696618] | 182 | <parameter>--system-libs</parameter>: This switch forces the build
|
---|
| 183 | system to link against the system installed version for all needed
|
---|
| 184 | libraries but those explicitly specified via a
|
---|
| 185 | <option>--no-system-*</option> option.
|
---|
[b7b6efc] | 186 | </para>
|
---|
[0d7900a] | 187 |
|
---|
[2c38e951] | 188 | <para>
|
---|
[5699c638] | 189 | <parameter>--no-system-jsoncpp</parameter> and
|
---|
| 190 | <parameter>--no-system-cppdap</parameter>: These switches remove the
|
---|
[2c38e951] | 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 |
|
---|
[d2c16a45] | 201 | <para>
|
---|
| 202 | <option>--no-system-{curl,libarchive,libuv,nghttp2}</option>: Use
|
---|
| 203 | the corresponding option in the list for the
|
---|
[95efba9] | 204 | <command>bootstrap</command> if one of the recommended dependencies is
|
---|
| 205 | not installed. A bundled version of the dependency will be used instead.
|
---|
[d2c16a45] | 206 | </para>
|
---|
| 207 |
|
---|
[b7b6efc] | 208 | <para>
|
---|
[fa2c610] | 209 | <option>--qt-gui</option>: This switch enables building the
|
---|
[b7b6efc] | 210 | <application>Qt</application>-based GUI for
|
---|
| 211 | <application>CMake</application>.
|
---|
| 212 | </para>
|
---|
[57f7cfa] | 213 |
|
---|
[cc64b232] | 214 | <para>
|
---|
[8558044] | 215 | <option>--parallel=</option>: This switch enables performing the
|
---|
[cc64b232] | 216 | <application>CMake</application> bootstrap with multiple jobs
|
---|
[29e16be] | 217 | at one time. It's not needed if the <envar>MAKEFLAGS</envar> variable
|
---|
| 218 | has been already set for using multiple processors following
|
---|
| 219 | <xref linkend='parallel-builds'/>.
|
---|
[cc64b232] | 220 | </para>
|
---|
| 221 |
|
---|
[57f7cfa] | 222 | </sect2>
|
---|
| 223 |
|
---|
| 224 | <sect2 role="content">
|
---|
| 225 | <title>Contents</title>
|
---|
| 226 |
|
---|
| 227 | <segmentedlist>
|
---|
[fd27868] | 228 | <segtitle>Installed Programs</segtitle>
|
---|
[c3c56b2] | 229 | <segtitle>Installed Libraries</segtitle>
|
---|
[fd27868] | 230 | <segtitle>Installed Directories</segtitle>
|
---|
[57f7cfa] | 231 |
|
---|
| 232 | <seglistitem>
|
---|
[b7b6efc] | 233 | <seg>
|
---|
[6c6f393] | 234 | ccmake, cmake, cmake-gui (optional), cpack, and ctest
|
---|
[b7b6efc] | 235 | </seg>
|
---|
[c3c56b2] | 236 | <seg>
|
---|
| 237 | None
|
---|
| 238 | </seg>
|
---|
[b7b6efc] | 239 | <seg>
|
---|
| 240 | /usr/share/cmake-&cmake-major-version; and
|
---|
| 241 | /usr/share/doc/cmake-&cmake-version;
|
---|
| 242 | </seg>
|
---|
[57f7cfa] | 243 | </seglistitem>
|
---|
| 244 | </segmentedlist>
|
---|
| 245 |
|
---|
[0d7900a] | 246 |
|
---|
[57f7cfa] | 247 | <variablelist>
|
---|
| 248 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 249 | <?dbfo list-presentation="list"?>
|
---|
| 250 | <?dbhtml list-presentation="table"?>
|
---|
| 251 |
|
---|
| 252 | <varlistentry id="ccmake">
|
---|
| 253 | <term><command>ccmake</command></term>
|
---|
| 254 | <listitem>
|
---|
[b7b6efc] | 255 | <para>
|
---|
| 256 | is a curses based interactive frontend to
|
---|
[4c24eb0a] | 257 | <command>cmake</command>
|
---|
[b7b6efc] | 258 | </para>
|
---|
[57f7cfa] | 259 | <indexterm zone="cmake ccmake">
|
---|
| 260 | <primary sortas="b-ccmake">ccmake</primary>
|
---|
| 261 | </indexterm>
|
---|
| 262 | </listitem>
|
---|
| 263 | </varlistentry>
|
---|
| 264 |
|
---|
[b7b6efc] | 265 | <varlistentry id="cmake-prog">
|
---|
[57f7cfa] | 266 | <term><command>cmake</command></term>
|
---|
| 267 | <listitem>
|
---|
[b7b6efc] | 268 | <para>
|
---|
[4c24eb0a] | 269 | is the makefile generator
|
---|
[b7b6efc] | 270 | </para>
|
---|
| 271 | <indexterm zone="cmake cmake-prog">
|
---|
[57f7cfa] | 272 | <primary sortas="b-cmake">cmake</primary>
|
---|
| 273 | </indexterm>
|
---|
| 274 | </listitem>
|
---|
| 275 | </varlistentry>
|
---|
[0d7900a] | 276 |
|
---|
[2bcddd4] | 277 | <varlistentry id="cmake-gui">
|
---|
| 278 | <term><command>cmake-gui</command></term>
|
---|
| 279 | <listitem>
|
---|
[b7b6efc] | 280 | <para>
|
---|
[fa2c610] | 281 | (optional) is the <application>Qt</application>-based frontend to
|
---|
[4c24eb0a] | 282 | <command>cmake</command>
|
---|
[b7b6efc] | 283 | </para>
|
---|
[2bcddd4] | 284 | <indexterm zone="cmake cmake-gui">
|
---|
| 285 | <primary sortas="b-cmake-gui">cmake-gui</primary>
|
---|
| 286 | </indexterm>
|
---|
| 287 | </listitem>
|
---|
| 288 | </varlistentry>
|
---|
| 289 |
|
---|
| 290 | <varlistentry id="cpack">
|
---|
| 291 | <term><command>cpack</command></term>
|
---|
| 292 | <listitem>
|
---|
[b7b6efc] | 293 | <para>
|
---|
[4c24eb0a] | 294 | is the <application>CMake</application> packaging program
|
---|
[b7b6efc] | 295 | </para>
|
---|
[2bcddd4] | 296 | <indexterm zone="cmake cpack">
|
---|
| 297 | <primary sortas="b-cpack">cpack</primary>
|
---|
| 298 | </indexterm>
|
---|
| 299 | </listitem>
|
---|
[0d7900a] | 300 | </varlistentry>
|
---|
| 301 |
|
---|
[2bcddd4] | 302 | <varlistentry id="ctest">
|
---|
| 303 | <term><command>ctest</command></term>
|
---|
| 304 | <listitem>
|
---|
[b7b6efc] | 305 | <para>
|
---|
[4c24eb0a] | 306 | is a testing utility for cmake-generated build trees
|
---|
[b7b6efc] | 307 | </para>
|
---|
[2bcddd4] | 308 | <indexterm zone="cmake ctest">
|
---|
| 309 | <primary sortas="b-ctest">ctest</primary>
|
---|
| 310 | </indexterm>
|
---|
| 311 | </listitem>
|
---|
| 312 | </varlistentry>
|
---|
[57f7cfa] | 313 |
|
---|
| 314 | </variablelist>
|
---|
| 315 |
|
---|
| 316 | </sect2>
|
---|
| 317 |
|
---|
| 318 | </sect1>
|
---|