ENH: add some docs for sgi CC
This commit is contained in:
Bill Hoffman
parent
78da2d0699
commit
56763afbca
275
CMake.rtf
275
CMake.rtf
|
|
@ -1,16 +1,16 @@
|
|||
{\rtf1\ansi\ansicpg1252\uc1 \deff0\deflang1033\deflangfe1033{\fonttbl{\f0\froman\fcharset0\fprq2{\*\panose 02020603050405020304}Times New Roman;}{\f2\fmodern\fcharset0\fprq1{\*\panose 02070309020205020404}Courier New;}
|
||||
{\f3\froman\fcharset2\fprq2{\*\panose 05050102010706020507}Symbol;}{\f14\fnil\fcharset2\fprq2{\*\panose 05000000000000000000}Wingdings;}{\f23\fmodern\fcharset128\fprq1{\*\panose 02020609040205080304}MS Mincho{\*\falt MS ??};}
|
||||
{\f28\fswiss\fcharset128\fprq2{\*\panose 020b0604020202020204}Arial Unicode MS;}{\f29\fswiss\fcharset0\fprq2{\*\panose 020b0604030504040204}Verdana;}{\f30\fmodern\fcharset128\fprq1{\*\panose 02020609040205080304}@MS Mincho;}
|
||||
{\f31\fswiss\fcharset128\fprq2{\*\panose 00000000000000000000}@Arial Unicode MS;}{\f46\froman\fcharset238\fprq2 Times New Roman CE;}{\f47\froman\fcharset204\fprq2 Times New Roman Cyr;}{\f49\froman\fcharset161\fprq2 Times New Roman Greek;}
|
||||
{\f50\froman\fcharset162\fprq2 Times New Roman Tur;}{\f51\froman\fcharset177\fprq2 Times New Roman (Hebrew);}{\f52\froman\fcharset178\fprq2 Times New Roman (Arabic);}{\f53\froman\fcharset186\fprq2 Times New Roman Baltic;}
|
||||
{\f62\fmodern\fcharset238\fprq1 Courier New CE;}{\f63\fmodern\fcharset204\fprq1 Courier New Cyr;}{\f65\fmodern\fcharset161\fprq1 Courier New Greek;}{\f66\fmodern\fcharset162\fprq1 Courier New Tur;}{\f67\fmodern\fcharset177\fprq1 Courier New (Hebrew);}
|
||||
{\f68\fmodern\fcharset178\fprq1 Courier New (Arabic);}{\f69\fmodern\fcharset186\fprq1 Courier New Baltic;}{\f232\fmodern\fcharset0\fprq1 MS Mincho Western{\*\falt MS ??};}{\f230\fmodern\fcharset238\fprq1 MS Mincho CE{\*\falt MS ??};}
|
||||
{\f231\fmodern\fcharset204\fprq1 MS Mincho Cyr{\*\falt MS ??};}{\f233\fmodern\fcharset161\fprq1 MS Mincho Greek{\*\falt MS ??};}{\f234\fmodern\fcharset162\fprq1 MS Mincho Tur{\*\falt MS ??};}
|
||||
{\f237\fmodern\fcharset186\fprq1 MS Mincho Baltic{\*\falt MS ??};}{\f272\fswiss\fcharset0\fprq2 Arial Unicode MS Western;}{\f270\fswiss\fcharset238\fprq2 Arial Unicode MS CE;}{\f271\fswiss\fcharset204\fprq2 Arial Unicode MS Cyr;}
|
||||
{\f273\fswiss\fcharset161\fprq2 Arial Unicode MS Greek;}{\f274\fswiss\fcharset162\fprq2 Arial Unicode MS Tur;}{\f275\fswiss\fcharset177\fprq2 Arial Unicode MS (Hebrew);}{\f276\fswiss\fcharset178\fprq2 Arial Unicode MS (Arabic);}
|
||||
{\f277\fswiss\fcharset186\fprq2 Arial Unicode MS Baltic;}{\f278\fswiss\fcharset238\fprq2 Verdana CE;}{\f279\fswiss\fcharset204\fprq2 Verdana Cyr;}{\f281\fswiss\fcharset161\fprq2 Verdana Greek;}{\f282\fswiss\fcharset162\fprq2 Verdana Tur;}
|
||||
{\f285\fswiss\fcharset186\fprq2 Verdana Baltic;}{\f288\fmodern\fcharset0\fprq1 @MS Mincho Western;}{\f286\fmodern\fcharset238\fprq1 @MS Mincho CE;}{\f287\fmodern\fcharset204\fprq1 @MS Mincho Cyr;}{\f289\fmodern\fcharset161\fprq1 @MS Mincho Greek;}
|
||||
{\f290\fmodern\fcharset162\fprq1 @MS Mincho Tur;}{\f293\fmodern\fcharset186\fprq1 @MS Mincho Baltic;}}{\colortbl;\red0\green0\blue0;\red0\green0\blue255;\red0\green255\blue255;\red0\green255\blue0;\red255\green0\blue255;\red255\green0\blue0;
|
||||
{\f31\fswiss\fcharset128\fprq2{\*\panose 00000000000000000000}@Arial Unicode MS;}{\f38\froman\fcharset238\fprq2 Times New Roman CE;}{\f39\froman\fcharset204\fprq2 Times New Roman Cyr;}{\f41\froman\fcharset161\fprq2 Times New Roman Greek;}
|
||||
{\f42\froman\fcharset162\fprq2 Times New Roman Tur;}{\f43\froman\fcharset177\fprq2 Times New Roman (Hebrew);}{\f44\froman\fcharset178\fprq2 Times New Roman (Arabic);}{\f45\froman\fcharset186\fprq2 Times New Roman Baltic;}
|
||||
{\f54\fmodern\fcharset238\fprq1 Courier New CE;}{\f55\fmodern\fcharset204\fprq1 Courier New Cyr;}{\f57\fmodern\fcharset161\fprq1 Courier New Greek;}{\f58\fmodern\fcharset162\fprq1 Courier New Tur;}{\f59\fmodern\fcharset177\fprq1 Courier New (Hebrew);}
|
||||
{\f60\fmodern\fcharset178\fprq1 Courier New (Arabic);}{\f61\fmodern\fcharset186\fprq1 Courier New Baltic;}{\f224\fmodern\fcharset0\fprq1 MS Mincho Western{\*\falt MS ??};}{\f222\fmodern\fcharset238\fprq1 MS Mincho CE{\*\falt MS ??};}
|
||||
{\f223\fmodern\fcharset204\fprq1 MS Mincho Cyr{\*\falt MS ??};}{\f225\fmodern\fcharset161\fprq1 MS Mincho Greek{\*\falt MS ??};}{\f226\fmodern\fcharset162\fprq1 MS Mincho Tur{\*\falt MS ??};}
|
||||
{\f229\fmodern\fcharset186\fprq1 MS Mincho Baltic{\*\falt MS ??};}{\f264\fswiss\fcharset0\fprq2 Arial Unicode MS Western;}{\f262\fswiss\fcharset238\fprq2 Arial Unicode MS CE;}{\f263\fswiss\fcharset204\fprq2 Arial Unicode MS Cyr;}
|
||||
{\f265\fswiss\fcharset161\fprq2 Arial Unicode MS Greek;}{\f266\fswiss\fcharset162\fprq2 Arial Unicode MS Tur;}{\f267\fswiss\fcharset177\fprq2 Arial Unicode MS (Hebrew);}{\f268\fswiss\fcharset178\fprq2 Arial Unicode MS (Arabic);}
|
||||
{\f269\fswiss\fcharset186\fprq2 Arial Unicode MS Baltic;}{\f270\fswiss\fcharset238\fprq2 Verdana CE;}{\f271\fswiss\fcharset204\fprq2 Verdana Cyr;}{\f273\fswiss\fcharset161\fprq2 Verdana Greek;}{\f274\fswiss\fcharset162\fprq2 Verdana Tur;}
|
||||
{\f277\fswiss\fcharset186\fprq2 Verdana Baltic;}{\f280\fmodern\fcharset0\fprq1 @MS Mincho Western;}{\f278\fmodern\fcharset238\fprq1 @MS Mincho CE;}{\f279\fmodern\fcharset204\fprq1 @MS Mincho Cyr;}{\f281\fmodern\fcharset161\fprq1 @MS Mincho Greek;}
|
||||
{\f282\fmodern\fcharset162\fprq1 @MS Mincho Tur;}{\f285\fmodern\fcharset186\fprq1 @MS Mincho Baltic;}}{\colortbl;\red0\green0\blue0;\red0\green0\blue255;\red0\green255\blue255;\red0\green255\blue0;\red255\green0\blue255;\red255\green0\blue0;
|
||||
\red255\green255\blue0;\red255\green255\blue255;\red0\green0\blue128;\red0\green128\blue128;\red0\green128\blue0;\red128\green0\blue128;\red128\green0\blue0;\red128\green128\blue0;\red128\green128\blue128;\red192\green192\blue192;}{\stylesheet{
|
||||
\ql \li1170\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin1170\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 \snext0 Normal;}{\s1\ql \li1170\ri-720\keepn\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin1170\itap0
|
||||
\b\fs36\ul\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 \sbasedon0 \snext0 heading 1;}{\s2\ql \li1170\ri-720\keepn\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin1170\itap0 \b\fs28\lang1033\langfe1033\cgrid\langnp1033\langfenp1033
|
||||
|
|
@ -114,8 +114,8 @@
|
|||
\listoverridecount0\ls6}{\listoverride\listid1839999324\listoverridecount0\ls7}{\listoverride\listid199510865\listoverridecount0\ls8}{\listoverride\listid908342481\listoverridecount0\ls9}{\listoverride\listid1336492021\listoverridecount0\ls10}
|
||||
{\listoverride\listid1592200748\listoverridecount0\ls11}{\listoverride\listid1724867039\listoverridecount0\ls12}{\listoverride\listid2012557743\listoverridecount0\ls13}{\listoverride\listid563219625\listoverridecount0\ls14}{\listoverride\listid1023172156
|
||||
\listoverridecount0\ls15}{\listoverride\listid1652054978\listoverridecount0\ls16}{\listoverride\listid1431699610\listoverridecount0\ls17}{\listoverride\listid330572609\listoverridecount0\ls18}{\listoverride\listid489949201\listoverridecount0\ls19}
|
||||
{\listoverride\listid1987126501\listoverridecount0\ls20}}{\info{\title CMake Documentation}{\author Ken Martin}{\operator hoffman}{\creatim\yr2001\mo6\dy7\hr15\min36}{\revtim\yr2001\mo8\dy7\hr11\min42}{\printim\yr2000\mo11\dy2\hr9\min34}{\version9}
|
||||
{\edmins53}{\nofpages14}{\nofwords4251}{\nofchars24231}{\*\company Kitware Inc.}{\nofcharsws29757}{\vern8269}}
|
||||
{\listoverride\listid1987126501\listoverridecount0\ls20}}{\info{\title CMake Documentation}{\author Ken Martin}{\operator hoffman}{\creatim\yr2001\mo6\dy7\hr15\min36}{\revtim\yr2001\mo8\dy9\hr15\min23}{\printim\yr2000\mo11\dy2\hr9\min34}{\version10}
|
||||
{\edmins142}{\nofpages14}{\nofwords4251}{\nofchars24231}{\*\company Kitware Inc.}{\nofcharsws0}{\vern8269}}
|
||||
\widowctrl\ftnbj\aendnotes\aftnstart0\hyphhotz0\aftnnar\noxlattoyen\expshrtn\noultrlspc\dntblnsbdb\nospaceforul\lytprtmet\hyphcaps0\horzdoc\dghspace180\dgvspace180\dghorigin1701\dgvorigin1984\dghshow0\dgvshow0
|
||||
\jexpand\viewkind1\viewscale75\pgbrdrhead\pgbrdrfoot\bdrrlswsix\nolnhtadjtbl \fet0\sectd \linex0\endnhere\sectdefaultcl {\*\pnseclvl1\pnucrm\pnstart1\pnindent720\pnhang{\pntxta .}}{\*\pnseclvl2\pnucltr\pnstart1\pnindent720\pnhang{\pntxta .}}{\*\pnseclvl3
|
||||
\pndec\pnstart1\pnindent720\pnhang{\pntxta .}}{\*\pnseclvl4\pnlcltr\pnstart1\pnindent720\pnhang{\pntxta )}}{\*\pnseclvl5\pndec\pnstart1\pnindent720\pnhang{\pntxtb (}{\pntxta )}}{\*\pnseclvl6\pnlcltr\pnstart1\pnindent720\pnhang{\pntxtb (}{\pntxta )}}
|
||||
|
|
@ -4807,10 +4807,10 @@ depends on the toolkits plus additional code. CMake can also handle situations w
|
|||
\par }\pard \qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {You can download and install precompiled binaries of CMake for Windows and UNIX from }{\field\flddirty{\*\fldinst { HYPERLINK "http://public.kitware.com/CMake" }{
|
||||
{\*\datafield
|
||||
00d0c9ea79f9bace118c8200aa004ba90b02000000170000002000000068007400740070003a002f002f007000750062006c00690063002e006b006900740077006100720065002e0063006f006d002f0043004d0061006b0065000000e0c9ea79f9bace118c8200aa004ba90b4000000068007400740070003a002f002f00
|
||||
7000750062006c00690063002e006b006900740077006100720065002e0063006f006d002f0043004d0061006b0065000000000000}}}{\fldrslt {\cs16\ul\cf2 http://public.kitware.com/CMake}}}{
|
||||
7000750062006c00690063002e006b006900740077006100720065002e0063006f006d002f0043004d0061006b006500000000000000}}}{\fldrslt {\cs16\ul\cf2 http://public.kitware.com/CMake}}}{
|
||||
. If you want to build CMake yourself, you can download the source code using CVS (available at }{\field\flddirty{\*\fldinst { HYPERLINK "http://cvshome.org" }{{\*\datafield
|
||||
00d0c9ea79f9bace118c8200aa004ba90b02000000170000001300000068007400740070003a002f002f0063007600730068006f006d0065002e006f00720067000000e0c9ea79f9bace118c8200aa004ba90b2800000068007400740070003a002f002f0063007600730068006f006d0065002e006f00720067002f000000
|
||||
000000}}}{\fldrslt {\cs16\ul\cf2 http://cvshome.org}}}{) and typing:
|
||||
00000000}}}{\fldrslt {\cs16\ul\cf2 http://cvshome.org}}}{) and typing:
|
||||
\par }\pard\plain \s23\ql \li0\ri0\sb100\sa100\sbauto1\saauto1\widctlpar\aspalpha\aspnum\faauto\adjustright\rin0\lin0\itap0 \f29\fs18\cf1\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {\b cvs -d :pserver:anonymous@public.kitware.com:/CMake/cvsroot login}{
|
||||
\line (respond with password cmake)
|
||||
\par Follow this command by checking out the source code:\line }{\b cvs -d :pserver:anonymous@public.kitware.com:/CMake/cvsroot co CMake}{
|
||||
|
|
@ -4823,19 +4823,31 @@ Then you can build CMake on Windows by loading the CMake.Source/CMake.dsp file i
|
|||
\par make
|
||||
\par make install
|
||||
\par
|
||||
\par On UNIX, if you are not using the GNU C++ compiler, you need to tell configure which compiler you want to use. This is done by setting the environment variable CXX before running configure. If you need to use any special flags with your compiler
|
||||
use the CXXFLAGS variable.
|
||||
\par
|
||||
\par For example on the SGI with the 7.3X compiler, you build like this:
|
||||
\par cd CMake
|
||||
\par (setenv CXX CC; setenv CXXFLAGS \'93-LANG:std\'94; ./configure)
|
||||
\par make
|
||||
\par make install
|
||||
\par
|
||||
\par
|
||||
\par
|
||||
\par }\pard\plain \s1\ql \li0\ri-720\keepn\widctlpar\aspalpha\aspnum\faauto\outlinelevel0\adjustright\rin-720\lin0\itap0 \b\fs36\ul\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {Running CMake
|
||||
\par }\pard\plain \qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {
|
||||
\par Once CMake has been installed on your system using it to build a project is easy. We will cover the process for Windows and then UNIX.
|
||||
\par }\pard \ql \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {
|
||||
\par }\pard\plain \s3\ql \li0\ri-720\keepn\widctlpar\aspalpha\aspnum\faauto\outlinelevel2\adjustright\rin-720\lin0\itap0 \b\fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {Running CMake for Windows / Microsoft Visual C++ (MSVC)
|
||||
\par }\pard\plain \ql \li0\ri-720\widctlpar\tx0\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {
|
||||
\par }\pard \qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {Run CMakeSetup.exe which should be in your Start menu under Program Files, there may also be a shortc
|
||||
ut on your desktop. A GUI will appear similar to what is shown below (but possibly different as CMake is still being developed). The top two entries are the source code and binary directories. They allow you to specify where the source code is for what yo
|
||||
u want to compile and where the resulting binaries should be placed. You should set these two values first. If the binary directory you specify does not exist, it will be created for you.
|
||||
\par }\pard \qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {Run CMakeSetup.exe which should be in your Start menu under Program Files, there may also be a shortcut on your des
|
||||
ktop. A GUI will appear similar to what is shown below (but possibly different as CMake is still being developed). The top two entries are the source code and binary directories. They allow you to specify where the source code is for what you want to comp
|
||||
ile and where the resulting binaries should be placed. You should set these two values first. If the binary directory you specify does not exist, it will be created for you.
|
||||
\par
|
||||
\par
|
||||
\par }{{\*\shppict{\pict{\*\picprop\shplid1033{\sp{\sn shapeType}{\sv 75}}{\sp{\sn fFlipH}{\sv 0}}{\sp{\sn fFlipV}{\sv 0}}{\sp{\sn fLine}{\sv 0}}{\sp{\sn fLayoutInCell}{\sv 1}}}\picscalex113\picscaley113\piccropl0\piccropr0\piccropt0\piccropb0
|
||||
\picw15108\pich10345\picwgoal8565\pichgoal5865\pngblip\bliptag1478193149{\*\blipuid 581b6ffda8faf6fb7fa9d9c247cf7a0e}89504e470d0a1a0a0000000d494844520000023b000001870802000000d954049f000000017352474200aece1ce900003abb49444154785eed9d4db46ec959d7
|
||||
\par }{{\*\shppict{\pict{\*\picprop\shplid1025{\sp{\sn shapeType}{\sv 75}}{\sp{\sn fFlipH}{\sv 0}}{\sp{\sn fFlipV}{\sv 0}}{\sp{\sn fLine}{\sv 0}}{\sp{\sn fLayoutInCell}{\sv 1}}{\sp{\sn fLayoutInCell}{\sv 1}}}
|
||||
\picscalex113\picscaley113\piccropl0\piccropr0\piccropt0\piccropb0\picw15108\pich10345\picwgoal8565\pichgoal5865\pngblip\bliptag1478193149{\*\blipuid 581b6ffda8faf6fb7fa9d9c247cf7a0e}
|
||||
89504e470d0a1a0a0000000d494844520000023b000001870802000000d954049f000000017352474200aece1ce900003abb49444154785eed9d4db46ec959d7
|
||||
fb3a7060942c9698f8016ba17480d0bd480785eea52cc875a9c459069938cf72206deca5804d201c6e48e08a8a57b961e0cac8b59cf5a0878da8e72a5f1d54ec
|
||||
4837f924ca971af91230995eeb3d75ee739f535fbbaa76d57ef7aefa1d4e9af7eeb7eaa9e7f955bdfbff3e55fb54ddfacbefffd74ff003010840000210d83d81
|
||||
5bafbff6eaee9dc441084000021080c01327c57aea1dcf4202021080000420b0670277eedcb956ac373ef1f13d3b8a6f1080000420303981975e7ee58f4c8e80
|
||||
|
|
@ -5070,7 +5082,7 @@ f6aee1bcd6177519fb57a5724528a358030f384283000420504dc02856cd9317c1adb84599ec73cf
|
|||
4bb4c7d109f90352074d2c73f209328d33f0a82234084000023d08d4e458762a2fb6ef8e9360b5759a04ab2d4fac4100021038108165c5b20a144b899c393d59
|
||||
9a2a9deb3b10325c850004200081b3105856ace0849ecc0a3a4a66e5cd5138b9989321f98511bfb38c0c1a85000420b03702a9bfc7da9baff8030108400002d3
|
||||
12a87c56705a5e040e0108400002672450332b784677691a0210800004a62580624ddbf5040e010840e0600450ac837518ee420002109896008a356dd7133804
|
||||
200081831140b10ed661b80b010840605a0228d6b45d4fe0108000040e4600c53a5887e12e042000816909fc7f39609ef0ec8b712e0000000049454e44ae426082}}{\nonshppict{\pict\picscalex114\picscaley114\piccropl0\piccropr0\piccropt0\piccropb0
|
||||
200081831140b10ed661b80b010840605a0228d6b45d4fe0108000040e4600c53a5887e12e042000816909fc7f39609ef0ec8b712e0000000049454e44ae426082}}{\nonshppict{\pict\picscalex113\picscaley113\piccropl0\piccropr0\piccropt0\piccropb0
|
||||
\picw15108\pich10345\picwgoal8565\pichgoal5865\wmetafile8\bliptag1478193149{\*\blipuid 581b6ffda8faf6fb7fa9d9c247cf7a0e}010009000003bc1e05000000981e050000000400000003010800050000000b0200000000050000000c0287013b0205000000070104000000981e0500430f2000
|
||||
cc00000087013b020000000087013b0200000000280000003b020000870100000100180000000000ec3c0a00c40e0000c40e00000000000000000000c8d0d4ff
|
||||
ffffc8d0d4c8d0d4c8d0d4c8d0d4c8d0d4c8d0d4c8d0d4c8d0d4c8d0d4c8d0d4c8d0d4c8d0d4c8d0d4c8d0d4c8d0d4c8d0d4c8d0d4c8d0d4c8d0d4c8d0d4c8d0
|
||||
|
|
@ -15558,13 +15570,13 @@ a56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa5
|
|||
6e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3aa56e3a00000005000000070101000000030000000000}}}{
|
||||
\par }\pard \qj \li810\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin810\itap0 {
|
||||
\par }\pard \qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {
|
||||
\par The cache values area is where you can specify different optio
|
||||
ns for the build process. The example shown below is for VTK which has a large number of options. Once you have specified the source code and binary directories you should click the Configure button. This will cause CMake to read in the CMakeLists.txt fil
|
||||
e
|
||||
s from the source code directory and the cache area to be updated to display any new options for the project. Adjust your cache settings if desired and click the Configure button again. New values that were caused by the configure process will be colored
|
||||
r
|
||||
ed. To be sure you have seen all possible values you should click Configure until no values are red and your are happy with all the settings. Once you are done configuring, click the OK button, this will produce Microsoft Visual C++ workspaces and exi
|
||||
t CMakeSetup.exe.
|
||||
\par The cache values area is where you can specify different options for the bui
|
||||
ld process. The example shown below is for VTK which has a large number of options. Once you have specified the source code and binary directories you should click the Configure button. This will cause CMake to read in the CMakeLists.txt files from the so
|
||||
u
|
||||
rce code directory and the cache area to be updated to display any new options for the project. Adjust your cache settings if desired and click the Configure button again. New values that were caused by the configure process will be colored red. To be s
|
||||
u
|
||||
re you have seen all possible values you should click Configure until no values are red and your are happy with all the settings. Once you are done configuring, click the OK button, this will produce Microsoft Visual C++ workspaces and exit CMakeSetup.e
|
||||
xe.
|
||||
\par
|
||||
\par CMakeSetup.exe generates a MSVC workspace file in the binary directory you specified. Typically this file has the same name as what you are compiling (e.g. VTK.dsp, ITK.dsw etc).
|
||||
\par The next step in this process is to open the workspace with MSVC. Once open, the project can be built in the normal manner of Microsoft Visual C++. The ALL_BUILD target can be used to build all of the libraries and executables in the package.
|
||||
|
|
@ -15572,29 +15584,29 @@ t CMakeSetup.exe.
|
|||
\par }\pard\plain \s22\qc \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {
|
||||
\par }\pard\plain \s3\ql \li0\ri-720\keepn\widctlpar\aspalpha\aspnum\faauto\outlinelevel2\adjustright\rin-720\lin0\itap0 \b\fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {Running CMake on Unix
|
||||
\par }\pard\plain \ql \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {
|
||||
\par If you have FLTK installed on your machine,
|
||||
a UNIX GUI will be produced for cmake. It is called CMakeSetup and is similar to the Windows GUI described above. The only difference is that it produces makefiles and not Microsoft project files. If you do not have FLTK, see the instructions for runn
|
||||
ing CMake from the command line.
|
||||
\par If you have FLTK installed on your machine, a UNIX GUI wil
|
||||
l be produced for cmake. It is called CMakeSetup and is similar to the Windows GUI described above. The only difference is that it produces makefiles and not Microsoft project files. If you do not have FLTK, see the instructions for running CMake from
|
||||
the command line.
|
||||
\par
|
||||
\par }\pard\plain \s3\ql \li0\ri-720\keepn\widctlpar\aspalpha\aspnum\faauto\outlinelevel2\adjustright\rin-720\lin0\itap0 \b\fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {Running CMake from the command line
|
||||
\par }\pard\plain \s22\ql \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {
|
||||
\par }\pard \s22\qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {
|
||||
Using CMake to build a project from the command line is a simple process. Change directory into where you want the binaries to be placed. This can be the same directory as the source cod
|
||||
e for what we call in-place builds (the binaries are in the same place as the source code) or it can be a new directory you create. For an in-place build you then run cmake and it will produce a CMakeCache.txt file that contains build options that you can
|
||||
|
||||
adjust using any text editor. For non in-place builds the process is the same except you run cmake and provide the path to the source code as its argument. Once you have edited the CMakeCache.txt file you rerun cmake, repeat this process until you are hap
|
||||
py with the cache settings. The type make and your project should compile. Some projects will have install targets as well so you can type make install to install them.
|
||||
Using CMake to build a project from the command line is a simple process. Change directory into where you want the binaries to be placed. This can be the same directory as the source code for what we
|
||||
call in-place builds (the binaries are in the same place as the source code) or it can be a new directory you create. For an in-place build you then run cmake and it will produce a CMakeCache.txt file that contains build options that you can adjust using
|
||||
a
|
||||
ny text editor. For non in-place builds the process is the same except you run cmake and provide the path to the source code as its argument. Once you have edited the CMakeCache.txt file you rerun cmake, repeat this process until you are happy with the ca
|
||||
che settings. The type make and your project should compile. Some projects will have install targets as well so you can type make install to install them.
|
||||
\par }\pard \s22\ql \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {
|
||||
\par }\pard \s22\qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {Two examples of CMake usage on the Unix platform follow for a hello world project calle
|
||||
d Hello. In the first example, and in-place build is performed, i.e., the binaries are placed in the same directory as the source code.
|
||||
\par }\pard \s22\qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {Two examples of CMake usage on the Unix platform follow for a hello world project called Hello. In th
|
||||
e first example, and in-place build is performed, i.e., the binaries are placed in the same directory as the source code.
|
||||
\par }\pard \s22\ql \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {
|
||||
\par }\pard\plain \ql \li720\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin720\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {cd Hello
|
||||
\par }\pard \ql \fi720\li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {cmake
|
||||
\par (optionally edit CMakeCache.txt and rerun cmake)
|
||||
\par }\pard\plain \s22\ql \fi720\li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {make
|
||||
\par }\pard \s22\qj \fi720\li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {
|
||||
\par }\pard \s22\qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {In the second example, an out-of-place build is p
|
||||
erformed, i.e., the source code, libraries, and executables are produced in a directory separate from the source code directory(ies).
|
||||
\par }\pard \s22\qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {In the second example, an out-of-place build is performed, i.e.
|
||||
, the source code, libraries, and executables are produced in a directory separate from the source code directory(ies).
|
||||
\par }\pard\plain \ql \li360\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin360\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {
|
||||
\par }\pard \ql \li720\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin720\itap0 {mkdir Hello-Linux
|
||||
\par cd Hello-Linux
|
||||
|
|
@ -15606,30 +15618,30 @@ erformed, i.e., the source code, libraries, and executables are produced in a di
|
|||
\par }\pard\plain \s3\ql \li0\ri-720\keepn\widctlpar\aspalpha\aspnum\faauto\outlinelevel2\adjustright\rin-720\lin0\itap0 \b\fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {What is the CMake cache?
|
||||
\par }\pard\plain \ql \li1170\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin1170\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {\dbch\af28
|
||||
\par }\pard \ql \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {
|
||||
The cache is better thought of as a configuration file. Indeed Unix users could consider the cache as equivalent to the set of flags passed to the configure command. The first time CMake is run, it produces a CMakeCache.txt file.\~ This f
|
||||
ile contains things like the existence and location of native JPEG library.\~ The entries are added in response to certain CMake commands (e.g. FIND_LIBRARY) as they are processed anywhere in CMakeLists files anywhere in the source tree.
|
||||
The cache is better thought of as a configuration file. Indeed Unix users could consider the cache as equivalent to the set of flags passed to the configure command. The first time CMake is run, it produces a CMakeCache.txt file.\~ This file contains t
|
||||
hings like the existence and location of native JPEG library.\~ The entries are added in response to certain CMake commands (e.g. FIND_LIBRARY) as they are processed anywhere in CMakeLists files anywhere in the source tree.
|
||||
\par
|
||||
\par After CMake has be
|
||||
en run, and created a CMakeCache.txt file - you may edit it. The CMake GUI, will allow you to edit the options easily, or you can edit the file directly. The main reason for editing the cache would be to give CMake the location of a native library such as
|
||||
JPEG, or to stop it from using a native library and use a version of the library in your source tree.
|
||||
\par After CMake has been run, and cr
|
||||
eated a CMakeCache.txt file - you may edit it. The CMake GUI, will allow you to edit the options easily, or you can edit the file directly. The main reason for editing the cache would be to give CMake the location of a native library such as JPEG, or to s
|
||||
top it from using a native library and use a version of the library in your source tree.
|
||||
\par }\pard \ql \li1170\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin1170\itap0 {
|
||||
\par }\pard \ql \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {CMake will not alter an existing entry in the cache file itself. If your CMakeLists.txt files change significantly, you will need to remove the relevant
|
||||
entries from the cache file. If you have not already hand-edited the cache file, you could just delete it before re-running CMake.
|
||||
\par }\pard \ql \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {CMake will not alter an existing entry in the cache file itself. If your CMakeLists.txt files change significantly, you will need to remove the relevant entries from t
|
||||
he cache file. If you have not already hand-edited the cache file, you could just delete it before re-running CMake.
|
||||
\par
|
||||
\par }\pard\plain \s3\ql \li0\ri-720\keepn\widctlpar\aspalpha\aspnum\faauto\outlinelevel2\adjustright\rin-720\lin0\itap0 \b\fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {Why do I have to edit the cache more than once for some projects?
|
||||
\par }\pard\plain \qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {
|
||||
\par Some projects are very complex and setting one value in
|
||||
the cache may cause new options to appear the next time the cache is built. For example, VTK supports the use of MPI for performing distributed computing. This requires the build process to determine where the MPI libraries and header files are and to le
|
||||
t the user adjust their values. But MPI is only available if another option VTK_USE_PARALLEL is first turned on in VTK. So to avoid confusion for people who don\rquote
|
||||
t know what MPI is, we hide those options until VTK_USE_PARALLEL is turned on. So CMake shows th
|
||||
e VTK_USE_PARALLEL option in the cache area, if the user turns that on and rebuilds the cache, new options will appear for MPI that they can then set. The rule is to keep building the cache until it doesn\rquote
|
||||
\par Some projects are very complex and setting one value in the cache may
|
||||
cause new options to appear the next time the cache is built. For example, VTK supports the use of MPI for performing distributed computing. This requires the build process to determine where the MPI libraries and header files are and to let the user adj
|
||||
ust their values. But MPI is only available if another option VTK_USE_PARALLEL is first turned on in VTK. So to avoid confusion for people who don\rquote
|
||||
t know what MPI is, we hide those options until VTK_USE_PARALLEL is turned on. So CMake shows the VTK_USE_PARA
|
||||
LLEL option in the cache area, if the user turns that on and rebuilds the cache, new options will appear for MPI that they can then set. The rule is to keep building the cache until it doesn\rquote
|
||||
t change. For most projects this will be just once. For some complicated ones it will be twice.
|
||||
\par
|
||||
\par }\pard\plain \s1\ql \li0\ri-720\keepn\widctlpar\aspalpha\aspnum\faauto\outlinelevel0\adjustright\rin-720\lin0\itap0 \b\fs36\ul\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {
|
||||
\par Developer's Guide
|
||||
\par }\pard\plain \qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {
|
||||
\par This section describes how to use CMake from the software developer\rquote s point of view. That is, if your aim is to use CMake to manage your build process, read this section first. An Extension
|
||||
Guide follows later in this document to explain the internals of CMake, and how to setup the CMake environment. Read that section only if you plan to install, extend, or enhance the features of CMake. This section of the User\rquote
|
||||
\par This section describes how to use CMake from the software developer\rquote s point of view. That is, if your aim is to use CMake to manage your build process, read this section first. An Extension Guide follows
|
||||
later in this document to explain the internals of CMake, and how to setup the CMake environment. Read that section only if you plan to install, extend, or enhance the features of CMake. This section of the User\rquote
|
||||
s Guide begins with a description of the CMake inputs. Examples then follow to clarify these descriptions.
|
||||
\par }\pard \ql \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {
|
||||
\par }\pard\plain \s2\ql \li0\ri-720\keepn\widctlpar\aspalpha\aspnum\faauto\outlinelevel1\adjustright\rin-720\lin0\itap0 \b\fs28\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {Input to CMake
|
||||
|
|
@ -15639,8 +15651,8 @@ s input is the text file CMakeLists.txt in your source directory. This input fil
|
|||
\par }\pard \ql \li720\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin720\itap0 {
|
||||
\par COMMAND(args\'85)
|
||||
\par
|
||||
\par }\pard \qj \li0\ri-720\nowidctlpar\faauto\rin-720\lin0\itap0 {Where COMMAND is the name of the command, and args is a white-space separated list of arguments to the command. (Arguments with embedded white-space should be qu
|
||||
oted.) Typically there will be a CMakeLists.txt file for each directory of the project. Let\rquote s start with a simple example. Consider building hello world. You would have a source tree with the following files:
|
||||
\par }\pard \qj \li0\ri-720\nowidctlpar\faauto\rin-720\lin0\itap0 {Where COMMAND is the name of the command, and args is a white-space separated list of arguments to the command. (Arguments with embedded white-space should be quoted.) Typical
|
||||
ly there will be a CMakeLists.txt file for each directory of the project. Let\rquote s start with a simple example. Consider building hello world. You would have a source tree with the following files:
|
||||
\par
|
||||
\par Hello.c CMakeLists.txt
|
||||
\par
|
||||
|
|
@ -15649,8 +15661,8 @@ oted.) Typically there will be a CMakeLists.txt file for each directory of the p
|
|||
\par PROJECT (Hello)
|
||||
\par ADD_EXECUTABLE(Hello Hello.c)
|
||||
\par
|
||||
\par To build the Hello executable you just follow the process described in }{\b Running CMake}{ above to generate the makefiles or Microsoft project files. The PROJECT command indicates what
|
||||
the name of the resulting workspace should be and the ADD_EXECUTABLE command adds an executable target to the build process. That\rquote
|
||||
\par To build the Hello executable you just follow the process described in }{\b Running CMake}{ above to generate the makefiles or Microsoft project files. The PROJECT command indicates what the name of th
|
||||
e resulting workspace should be and the ADD_EXECUTABLE command adds an executable target to the build process. That\rquote
|
||||
s all there is to it for this simple example. If your project requires a few files it is also quite easy, just modify the ADD_EXECUTABLE line as shown below.
|
||||
\par
|
||||
\par ADD_EXECUTABLE(Hello Hello.c File2.c File3.c File4.c)
|
||||
|
|
@ -15673,13 +15685,13 @@ s all there is to it for this simple example. If your project requires a few fil
|
|||
\par TARGET_ADD_LIBRARY (Hello TCL_LIBRARY)
|
||||
\par ENDIF (TCL_LIBRARY)
|
||||
\par
|
||||
\par }\pard \qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {In this example the SOURCE_FILES command is used to group together source files into a list. The IF command is used to add either WinSupport.c or UnixS
|
||||
upport.c to this list. And finally the ADD_EXECUTABLE command is used to build the executable with the files listed in the source list HELLO_SRCS. The FIND_LIBRARY command looks for the Tcl library under a few different names and in a few different paths,
|
||||
and if it is found adds it to the link line for the Hello executable target. Note the use of the # character to denote a comment line.
|
||||
\par }\pard \qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {In this example the SOURCE_FILES command is used to group together source files into a list. The IF command is used to add either WinSupport.c or UnixSupport.c to th
|
||||
is list. And finally the ADD_EXECUTABLE command is used to build the executable with the files listed in the source list HELLO_SRCS. The FIND_LIBRARY command looks for the Tcl library under a few different names and in a few different paths, and if it is
|
||||
found adds it to the link line for the Hello executable target. Note the use of the # character to denote a comment line.
|
||||
\par }\pard \ql \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {
|
||||
\par }\pard \qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {CMake always defines some variables for use within CMakeList files. For example, WIN32 is always defined on windows syst
|
||||
ems and UNIX is always defined for UNIX systems. CMake defines a number of commands. A brief summary of the most commonly used commands follows here. Later in the document an exhaustive list of all pre-defined commands is presented. (You may also add your
|
||||
own commands, see the Extension Guide for more information.)
|
||||
\par }\pard \qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {CMake always defines some variables for use within CMakeList files. For example, WIN32 is always defined on windows systems and UNIX i
|
||||
s always defined for UNIX systems. CMake defines a number of commands. A brief summary of the most commonly used commands follows here. Later in the document an exhaustive list of all pre-defined commands is presented. (You may also add your own commands,
|
||||
see the Extension Guide for more information.)
|
||||
\par }\pard \ql \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {
|
||||
\par {\pntext\pard\plain\hich\af0\dbch\af0\loch\f0 A)\tab}}\pard \ql \fi-360\li720\ri-720\widctlpar\jclisttab\tx720{\*\pn \pnlvlbody\ilvl0\ls9\pnrnot0\pnucltr\pnstart1\pnindent360\pnsp120\pnhang{\pntxta )}}
|
||||
\aspalpha\aspnum\faauto\ls9\adjustright\rin-720\lin720\itap0 {Build Targets:
|
||||
|
|
@ -15690,13 +15702,13 @@ ems and UNIX is always defined for UNIX systems. CMake defines a number of comma
|
|||
\par AUX_SOURCE_DIRECTORY()
|
||||
\par PROJECT()
|
||||
\par }\pard \ql \li720\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin720\itap0 {
|
||||
\par }\pard \qj \li720\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin720\itap0 {CMake works recursively, descending from the current directory into any subdirectories
|
||||
listed in the SUBDIRS command. The command SOURCE_FILES is used for grouping source files together for later use. (Note: currently only C and C++ code can be compiled.) ADD_LIBRARY adds a library to the list of targets this makefile will produce. ADD_EXEC
|
||||
U
|
||||
TABLE adds an executable to the list of targets this makefile will produce. (Note: source code is compiled first, then libraries are built, and then executables are created.) The AUX_SOURCE_DIRECTORY is a directory where other source code, not in this dir
|
||||
e
|
||||
ctory, whose object code is to be inserted into the current LIBRARY. All source files in the AUX_SOURCE_DIRECTORY are compiled (e.g. *.c, *.cxx, *.cpp, etc.). PROJECT (PojectName) is a special variable used in the MSVC to create the project for the compi
|
||||
ler, it also defines two useful variables for CMAKE: ProjectName_SOURCE_DIR and ProjectName_BINARY_DIR.
|
||||
\par }\pard \qj \li720\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin720\itap0 {CMake works recursively, descending from the current directory into any subdirectories listed in the
|
||||
SUBDIRS command. The command SOURCE_FILES is used for grouping source files together for later use. (Note: currently only C and C++ code can be compiled.) ADD_LIBRARY adds a library to the list of targets this makefile will produce. ADD_EXECUTABLE adds an
|
||||
|
||||
executable to the list of targets this makefile will produce. (Note: source code is compiled first, then libraries are built, and then executables are created.) The AUX_SOURCE_DIRECTORY is a directory where other source code, not in this directory, whose
|
||||
o
|
||||
bject code is to be inserted into the current LIBRARY. All source files in the AUX_SOURCE_DIRECTORY are compiled (e.g. *.c, *.cxx, *.cpp, etc.). PROJECT (PojectName) is a special variable used in the MSVC to create the project for the compiler, it also d
|
||||
efines two useful variables for CMAKE: ProjectName_SOURCE_DIR and ProjectName_BINARY_DIR.
|
||||
\par }\pard \ql \fi720\li720\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin720\itap0 {
|
||||
\par {\pntext\pard\plain\hich\af0\dbch\af0\loch\f0 B)\tab}}\pard \ql \fi-360\li720\ri-720\widctlpar{\*\pn \pnlvlbody\ilvl0\ls6\pnrnot0\pnucltr\pnstart2\pnindent360\pnsp120\pnhang{\pntxta )}}\aspalpha\aspnum\faauto\ls6\adjustright\rin-720\lin720\itap0 {
|
||||
Build flags and options. In addition to the commands listed above, CMakeLists.txt often contain the following commands:
|
||||
|
|
@ -15707,20 +15719,20 @@ Build flags and options. In addition to the commands listed above, CMakeLists.t
|
|||
\par TARGET_LINK_LIBRARIES()
|
||||
\par }\pard \ql \li720\ri-720\widctlpar{\*\pn \pnlvlcont\ilvl0\ls0\pnrnot0\pndec }\aspalpha\aspnum\faauto\adjustright\rin-720\lin720\itap0 {
|
||||
\par }\pard \qj \li720\ri-720\widctlpar{\*\pn \pnlvlcont\ilvl0\ls0\pnrnot0\pndec }\aspalpha\aspnum\faauto\adjustright\rin-720\lin720\itap0 {
|
||||
These commands define directories and libraries used to compile source code and build executables. An important feature of the commands listed above is that are inherited by any subdirectories. That is,
|
||||
as CMake descends through a directory hierarchy (defined by SUBDIRS()) these commands are expanded each time a definition for a command is encountered. For example, if in the top-level CMakeLists file has INCLUDE_DIRECTORIES(/usr/include), with SUBDIRS(.
|
||||
/subdir1), and the file ./subdir1/CMakeLists.txt has INCLUDE_DIRECTORIES(/tmp/foobar), then the net result is
|
||||
These commands define directories and libraries used to compile source code and build executables. An important feature of the commands listed above is that are inherited by any subdirectories. That is, as CMake desc
|
||||
ends through a directory hierarchy (defined by SUBDIRS()) these commands are expanded each time a definition for a command is encountered. For example, if in the top-level CMakeLists file has INCLUDE_DIRECTORIES(/usr/include), with SUBDIRS(./subdir1), and
|
||||
the file ./subdir1/CMakeLists.txt has INCLUDE_DIRECTORIES(/tmp/foobar), then the net result is
|
||||
\par }\pard \ql \li1170\ri-720\widctlpar{\*\pn \pnlvlcont\ilvl0\ls0\pnrnot0\pndec }\aspalpha\aspnum\faauto\adjustright\rin-720\lin1170\itap0 {
|
||||
\par \tab INCLUDE_DIRECTORIES(/usr/include /tmp/foobar)
|
||||
\par
|
||||
\par {\pntext\pard\plain\hich\af0\dbch\af0\loch\f0 C)\tab}}\pard \qj \fi-360\li720\ri-720\widctlpar{\*\pn \pnlvlbody\ilvl0\ls6\pnrnot0\pnucltr\pnstart2\pnindent360\pnsp120\pnhang{\pntxta )}}\aspalpha\aspnum\faauto\ls6\adjustright\rin-720\lin720\itap0 {
|
||||
CMake comes with a number of modules that look for commonly used packages such as OpenGL or Java.
|
||||
These modules save you from having to write all the CMake code to find these packages yourself. Modules can be used by including them into your CMakeList file as shown below.
|
||||
CMake comes with a number of modules that look for commonly used packages such as OpenGL or Java. These modules
|
||||
save you from having to write all the CMake code to find these packages yourself. Modules can be used by including them into your CMakeList file as shown below.
|
||||
\par }\pard \ql \li1440\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin1440\itap0 {
|
||||
\par INCLUDE ($\{CMAKE_ROOT\}/Modules/FindTCL.cmake)
|
||||
\par
|
||||
\par }\pard \qj \li720\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin720\itap0 {CMAKE_ROOT is always defined in
|
||||
CMake and can be used to point to where CMake was installed. Looking through some of the files in the Modules subdirectory can provide good ideas on how to use some of the CMake commands.
|
||||
\par }\pard \qj \li720\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin720\itap0 {CMAKE_ROOT is always defined in CMake and can
|
||||
be used to point to where CMake was installed. Looking through some of the files in the Modules subdirectory can provide good ideas on how to use some of the CMake commands.
|
||||
\par }\pard\plain \s3\ql \li0\ri-720\keepn\widctlpar\aspalpha\aspnum\faauto\outlinelevel2\adjustright\rin-720\lin0\itap0 \b\fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {
|
||||
\par Adding A New Directory to a project
|
||||
\par }\pard\plain \s22\ql \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {A common way to extend a project is to add a new directory. This involves three steps:
|
||||
|
|
@ -15731,8 +15743,8 @@ These modules save you from having to write all the CMake code to find these pac
|
|||
\par {\listtext\pard\plain\s22 \hich\af0\dbch\af0\loch\f0 2.\tab}}\pard \s22\ql \fi-360\li720\ri-720\widctlpar\jclisttab\tx720\aspalpha\aspnum\faauto\ls16\adjustright\rin-720\lin720\itap0 {
|
||||
Add the new directory to the SUBDIRS command in the parent directories CMakeLists.txt
|
||||
\par }\pard \s22\ql \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {
|
||||
\par {\listtext\pard\plain\s22 \hich\af0\dbch\af0\loch\f0 3.\tab}}\pard \s22\ql \fi-360\li720\ri-720\widctlpar\jclisttab\tx720\aspalpha\aspnum\faauto\ls16\adjustright\rin-720\lin720\itap0 {Create a CMakeLists.txt in the new dire
|
||||
ctory with the appropriate commands
|
||||
\par {\listtext\pard\plain\s22 \hich\af0\dbch\af0\loch\f0 3.\tab}}\pard \s22\ql \fi-360\li720\ri-720\widctlpar\jclisttab\tx720\aspalpha\aspnum\faauto\ls16\adjustright\rin-720\lin720\itap0 {Create a CMakeLists.txt in the new directory with the
|
||||
appropriate commands
|
||||
\par }\pard\plain \ql \li1170\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin1170\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {
|
||||
\par
|
||||
\par }\pard\plain \s2\ql \li0\ri-720\keepn\widctlpar\aspalpha\aspnum\faauto\outlinelevel1\adjustright\rin-720\lin0\itap0 \b\fs28\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {CMake Commands
|
||||
|
|
@ -15747,31 +15759,31 @@ ctory with the appropriate commands
|
|||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b ADD_DEPENDENCIES}{ - Add an dependency to a target \line }{\i Usage:}{
|
||||
ADD_DEPENDENCIES(target-name depend-target depend-target) Add a dependency to a target. This is only used to add dependecies between one executable and another. Regular build dependencies are handled automatically.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b ADD_EXECUTABLE}{ - Add an executable to the project that uses the specified srclists \line }{\i Usage:}{
|
||||
ADD_EXECUTABLE(exename srclist srclist srclist ...) ADD_EXECUTABLE(exename WIN32 srclist srclist srclist ...)This command adds an executable target to the current directory. The executa
|
||||
ble will be built from the source files / source lists specified. The second argument to this command can be WIN32 which indicates that the executable (when compiled on windows) is a windows app (using WinMain)not a console app (using main).
|
||||
ADD_EXECUTABLE(exename srclist srclist srclist ...) ADD_EXECUTABLE(exename WIN32 srclist srclist srclist ...)This command adds an executable target to the current directory. The executable will be bu
|
||||
ilt from the source files / source lists specified. The second argument to this command can be WIN32 which indicates that the executable (when compiled on windows) is a windows app (using WinMain)not a console app (using main).
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b ADD_LIBRARY}{ - Add an library to the project that uses the specified srclists \line }{\i Usage:}{
|
||||
ADD_LIBRARY(libname [SHARED | STATIC] srclist srclist srclist ...) Adds a library target. If the keyword SHARED or STATIC appears, it sets the library type. If neither keyword appears a
|
||||
s the second argument, the type defaults to the current value of BUILD_SHARED_LIBS. If this variable is not set, the type defaults to STATIC.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b ADD_TEST}{ - Add a test to the project with the specified arguments. \line }{\i Usage:}{ ADD_TEST(testname exename arg1 arg2 arg
|
||||
3 ...) This command adds a test target to the current directory. The tests are run by the testing subsystem by executing exename with the specified arguments. exename can be either an executable built by built by this project or an arbitrary executable on
|
||||
the system (like tclsh).
|
||||
ADD_LIBRARY(libname [SHARED | STATIC] srclist srclist srclist ...) Adds a library target. If the keyword SHARED or STATIC appears, it sets the library type. If neither keyword appears as the second a
|
||||
rgument, the type defaults to the current value of BUILD_SHARED_LIBS. If this variable is not set, the type defaults to STATIC.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b ADD_TEST}{ - Add a test to the project with the specified arguments. \line }{\i Usage:}{ ADD_TEST(testname exename arg1 arg2 arg3 ...) This co
|
||||
mmand adds a test target to the current directory. The tests are run by the testing subsystem by executing exename with the specified arguments. exename can be either an executable built by built by this project or an arbitrary executable on the system (l
|
||||
ike tclsh).
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b AUX_SOURCE_DIRECTORY}{ - Add all the source files found in the specified directory to the build as source list NAME. \line }{\i Usage:}{ AUX_SOURCE_DIRECTORY(dir srcListName)
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b BUILD_COMMAND}{ - Determine the command line that will build this project. \line }{\i Usage:}{
|
||||
BUILD_COMMAND(NAME) Within CMAKE set NAME to the command that will build this project from the command line.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b BUILD_COMMAND}{ - Determine the command line that will build this project. \line }{\i Usage:}{ BUI
|
||||
LD_COMMAND(NAME) Within CMAKE set NAME to the command that will build this project from the command line.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b BUILD_NAME}{ - Set a CMAKE variable to the build type. \line }{\i Usage:}{ BUILD_NAME(NAME) Within CMAKE sets NAME to the build type.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b CABLE_CLASS_SET}{ - Define a set of classes for use in other CABLE commands. \line }{\i Usage:}{
|
||||
CABLE_CLASS_SET(set_name class1 class2 ...) Defines a set with the given name containing classes and their associated header files. The set can later be used by other CABLE commands.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b CABLE_WRAP_TCL}{ - Wrap a set of classes in Tcl. \line }{\i Usage:}{
|
||||
CABLE_WRAP_TCL(target class1 class2 ...) Wrap the given set of classes in Tcl using the CABLE tool. The set of source files produced for the given package name will be added to a source list with the given name.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b CONFIGURE_FILE}{ - Create a file from an autoconf style file.in file. \line }{\i Usage:}{
|
||||
CONFIGURE_FILE(InputFile OutputFile [COPYONLY] [ESCAPE_QUOTES] [IMMEDIATE]) The Input and Ouput files have to have full paths. They can also use variables like CMAKE_BINARY_DI
|
||||
R,CMAKE_SOURCE_DIR. This command replaces any variables in the input file with their values as determined by CMake. If a variables in not defined, it will be replaced with nothing. If COPYONLY is passed in, then then no varible expansion will take place.
|
||||
If ESCAPE_QUOTES is passed in then any substitued quotes will be C style escaped. If IMMEDIATE is specified, then the file will be configured with the current values of CMake variables instead of waiting until the end of CMakeLists processing.
|
||||
CONFIGURE_FILE(InputFile OutputFile [COPYONLY] [ESCAPE_QUOTES] [IMMEDIATE]) The Input and Ouput files have to have full paths. They can also use variables like CMAKE_BINARY_DIR,CMAKE_SOURCE
|
||||
_DIR. This command replaces any variables in the input file with their values as determined by CMake. If a variables in not defined, it will be replaced with nothing. If COPYONLY is passed in, then then no varible expansion will take place. If ESCAPE_QUOT
|
||||
ES is passed in then any substitued quotes will be C style escaped. If IMMEDIATE is specified, then the file will be configured with the current values of CMake variables instead of waiting until the end of CMakeLists processing.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b CONFIGURE_GCCXML}{ - Configure the flags needed for GCC-XML to run. \line }{\i Usage:}{
|
||||
CONFIGURE_GCCXML(exe_location flags_def) Configures the flags GCC-XML needs to parse source code just as the current compiler would. This includes using the compiler's standard header files. Firs
|
||||
t argument is input of the full path to the GCC-XML executable. The second argument should be the name of a cache entry to set with the flags chosen.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b ELSE}{ - starts the else portion of an if block \line }{\i Usage:}{ ELSE(args), Note that the args for the ELSE clause
|
||||
must match those of the IF clause. See the IF command for more information.
|
||||
CONFIGURE_GCCXML(exe_location flags_def) Configures the flags GCC-XML needs to parse source code just as the current compiler would. This includes using the compiler's standard header files. First argument is
|
||||
input of the full path to the GCC-XML executable. The second argument should be the name of a cache entry to set with the flags chosen.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b ELSE}{ - starts the else portion of an if block \line }{\i Usage:}{ ELSE(args), Note that the args for the ELSE clause must match tho
|
||||
se of the IF clause. See the IF command for more information.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b ENABLE_TESTING}{ - Enable testing for this directory and below. \line }{\i Usage:}{ ENABLE_TESTING() Enables testing for this directory and below. See also the ADD_TEST command.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b ENDFOREACH}{ - ends a foreach block \line }{\i Usage:}{ ENDFOREACH(define)
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b ENDIF}{ - ends an if block \line }{\i Usage:}{ ENDIF(define)
|
||||
|
|
@ -15783,47 +15795,46 @@ must match those of the IF clause. See the IF command for more information.
|
|||
FIND_PATH(PATH_DEFINE fileName path1 path2 path3...) If the file is found, then PATH_DEFINE is set to the path where it was found
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b FIND_PROGRAM}{ - Find an executable program. \line }{\i Usage:}{ FIND_PROGRAM(NAME executable1 extrapath extrapath ...)
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b FOREACH}{ - start a foreach loop \line }{\i Usage:}{ FOREACH (define arg1 arg2 arg2) Starts a foreach block.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b GET_FILENAME_COMPONENT}{ - Get a specific component of a full filename. \line }{\i Usage:}{ GET_FILENAME_COMPONENT(VarName FileName PATH|NAME|EXT|NAME_W
|
||||
E) Set VarName to be the path (PATH), file name (NAME), file extension (EXT) or file name without extension (NAME_WE) of FileName. Note that the path is converted to Unix slashes format and has no trailing slashes. The longest file extension is always con
|
||||
sidered.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b GET_FILENAME_COMPONENT}{ - Get a specific component of a full filename. \line }{\i Usage:}{ GET_FILENAME_COMPONENT(VarName FileName PATH|NAME|EXT|NAME_WE) Set VarName
|
||||
to be the path (PATH), file name (NAME), file extension (EXT) or file name without extension (NAME_WE) of FileName. Note that the path is converted to Unix slashes format and has no trailing slashes. The longest file extension is always considered.
|
||||
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b IF}{ - start an if block \line }{\i Usage:}{
|
||||
IF (define) Starts an if block. Optionally it can be invoked using (NOT define) (def AND def2) (def OR def2) (def MATCHES def2) MATCHES checks if def matches the regular expression def2
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b INCLUDE}{ - Basically identical to a C #include "somthing" command. \line }{\i Usage:}{
|
||||
INCLUDE(file1 [OPTIONAL]) If OPTIONAL is present, then do not complain if the file does not exist.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b INCLUDE_DIRECTORIES}{ - Add include directories to the build. \line }{\i Usage:}{ INCLUDE_DIRECTORIES(dir1 dir2 ...)
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b INCLUDE_REGULAR_EXPRESSION}{ - Set the regular expression used for dependency checking. \line }{\i Usage:}{
|
||||
INCLUDE_REGULAR_EXPRESSION(regex_match [regex_complain]) Set the regular expressions used in dependency checking. Only files matching regex_match will be traced as dependen
|
||||
cies. Only files matching regex_complain will generate warnings if they cannot be found (standard header paths are not searched). The defaults are: regex_match = "^.*$" (match everything) regex_complain = "^$" (match empty string only)
|
||||
INCLUDE_REGULAR_EXPRESSION(regex_match [regex_complain]) Set the regular expressions used in dependency checking. Only files matching regex_match will be traced as dependencies. Only fil
|
||||
es matching regex_complain will generate warnings if they cannot be found (standard header paths are not searched). The defaults are: regex_match = "^.*$" (match everything) regex_complain = "^$" (match empty string only)
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b INSTALL_FILES}{ - Create install rules for files \line }{\i Usage:}{
|
||||
INSTALL_FILES(path extension srclist file file srclist ...) INSTALL_FILES(path regexp) Create rules to install the listed files into the path. Path is relative to the variable CMAKE_INSTALL_PREFIX. There are two forms fo
|
||||
r this command. In the first the files can be specified explicitly or by referenceing source lists. All files must either have the extension specified or exist with the extension appended. A typical extension is .h etc... In the second form any files in t
|
||||
he current directory that match the regular expression will be installed.
|
||||
INSTALL_FILES(path extension srclist file file srclist ...) INSTALL_FILES(path regexp) Create rules to install the listed files into the path. Path is relative to the variable CMAKE_INSTALL_PREFIX. There are two forms for this command
|
||||
. In the first the files can be specified explicitly or by referenceing source lists. All files must either have the extension specified or exist with the extension appended. A typical extension is .h etc... In the second form any files in the current dir
|
||||
ectory that match the regular expression will be installed.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b INSTALL_PROGRAMS}{ - Create install rules for programs \line }{\i Usage:}{
|
||||
INSTALL_PROGRAMS(path file file ...) INSTALL_PROGRAMS(path regexp) Create rules to install the listed programs into the pa
|
||||
th. Path is relative to the variable CMAKE_INSTALL_PREFIX. There are two forms for this command. In the first the programs can be specified explicitly. In the second form any program in the current directory that match the regular expression will be insta
|
||||
lled.
|
||||
INSTALL_PROGRAMS(path file file ...) INSTALL_PROGRAMS(path regexp) Create rules to install the listed programs into the path. Path is re
|
||||
lative to the variable CMAKE_INSTALL_PREFIX. There are two forms for this command. In the first the programs can be specified explicitly. In the second form any program in the current directory that match the regular expression will be installed.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b INSTALL_TARGETS}{ - Create install rules for targets \line }{\i Usage:}{
|
||||
INSTALL_TARGETS(path target target) Create rules to install the listed targets into the path. Path is relative to the variable PREFIX
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b LINK_DIRECTORIES}{ - Specify link directories. \line }{\i Usage:}{ LINK_
|
||||
DIRECTORIES(directory1 directory2 ...) Specify the paths to the libraries that will be linked in. The directories can use built in definitions like CMAKE_BINARY_DIR and CMAKE_SOURCE_DIR.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b LINK_DIRECTORIES}{ - Specify link directories. \line }{\i Usage:}{ LINK_DIRECTORIES(di
|
||||
rectory1 directory2 ...) Specify the paths to the libraries that will be linked in. The directories can use built in definitions like CMAKE_BINARY_DIR and CMAKE_SOURCE_DIR.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b LINK_LIBRARIES}{ - Specify a list of libraries to be linked into executables or shared objects. \line }{\i Usage:}{
|
||||
LINK_LIBRARIES(library1 library2 ...) Specify a list of libraries to be linked into executables or shared objects. This command is passed down to all other commands. The debug and optimized strings may be used to indicate t
|
||||
hat the next library listed is to be used only for that specific type of build
|
||||
LINK_LIBRARIES(library1 library2 ...) Specify a list of libraries to be linked into executables or shared objects. This command is passed down to all other commands. The debug and optimized strings may be used to indicate that the next l
|
||||
ibrary listed is to be used only for that specific type of build
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b LOAD_CACHE}{ - load in the values from another cache. \line }{\i Usage:}{
|
||||
LOAD_CACHE(pathToCacheFile) Load in the values from another cache. This is useful for a project that depends on another project built in a different tree.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b MAKE_DIRECTORY}{ - Create a directory in the build tree if it does not exist. Parent directories will be created if the do not exist.. \line }{\i Usage:}{ MAKE_DIRECTORY(directory)
|
||||
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b MESSAGE}{ - Display a message to the user. \line }{\i Usage:}{ ME
|
||||
SSAGE("the message to display" "Title for dialog") The first argument is the message to display. The second argument is optional and is the title for the dialog box on windows.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b OPTION}{ - Provides an option that the user can optionally select \line }{\i Usage:}{ OPTION(
|
||||
USE_MPI "help string decribing the option" [initial value]) Provide an option for the user to select
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b OUTPUT_REQUIRED_FILES}{ - Output a list of required source files for a specified source file. \line }{\i Usage:}{ OUTPUT_REQUIRED_FILES(srcfile outputfile) Outputs a lis
|
||||
t of all the source files that are required by the specified srcfile. This list is written into outputfile. This is similar to writing out the dependencies for srcfile except that it jumps from .h files into .cxx, .c and .cpp files if possible.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b MESSAGE}{ - Display a message to the user. \line }{\i Usage:}{ MESSAGE("the mes
|
||||
sage to display" "Title for dialog") The first argument is the message to display. The second argument is optional and is the title for the dialog box on windows.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b OPTION}{ - Provides an option that the user can optionally select \line }{\i Usage:}{ OPTION(USE_MPI "help
|
||||
string decribing the option" [initial value]) Provide an option for the user to select
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b OUTPUT_REQUIRED_FILES}{ - Output a list of required source files for a specified source file. \line }{\i Usage:}{ OUTPUT_REQUIRED_FILES(srcfile outputfile) Outputs a list of all the s
|
||||
ource files that are required by the specified srcfile. This list is written into outputfile. This is similar to writing out the dependencies for srcfile except that it jumps from .h files into .cxx, .c and .cpp files if possible.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b PROJECT}{ - Set a name for the entire project. One argument. \line }{\i Usage:}{
|
||||
PROJECT(projectname) Sets the name of the Microsoft workspace .dsw file. Does nothing on UNIX currently
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b SET}{ - Set a CMAKE variable to a value \line }{\i Usage:}{ SET(VAR [VALUE] [CACHE TYPE DOCSTRING]) Within CM
|
||||
AKE sets VAR to the value VALUE. VALUE is expanded before VAR is set to it. If CACHE is present, then the VAR is put in the cache. TYPE and DOCSTRING are required. If TYPE is INTERNAL, then the VALUE is Always written into the cache, replacing any values
|
||||
existing in the cache. If it is not a CACHE VAR, then this always writes into the current makefile.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b SET}{ - Set a CMAKE variable to a value \line }{\i Usage:}{ SET(VAR [VALUE] [CACHE TYPE DOCSTRING]) Within CMAKE sets VAR t
|
||||
o the value VALUE. VALUE is expanded before VAR is set to it. If CACHE is present, then the VAR is put in the cache. TYPE and DOCSTRING are required. If TYPE is INTERNAL, then the VALUE is Always written into the cache, replacing any values existing in th
|
||||
e cache. If it is not a CACHE VAR, then this always writes into the current makefile.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b SITE_NAME}{ - Set a CMAKE variable to the name of this computer. \line }{\i Usage:}{ SITE_NAME(NAME) Within CMAKE sets NAME to the host name of the computer.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b SOURCE_FILES}{ - Add a list of source files, associate them with a NAME. \line }{\i Usage:}{ SOURCE_FILES(NAME file1 file2 ...)
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b SOURCE_FILES_REMOVE}{ - Remove a list of source files - associated with NAME. \line }{\i Usage:}{ SOURCE_FILES_REMOVE(NAME file1 file2 ...)
|
||||
|
|
@ -15836,9 +15847,9 @@ existing in the cache. If it is not a CACHE VAR, then this always writes into th
|
|||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b TARGET_LINK_LIBRARIES}{ - Specify a list of libraries to be linked into executables or shared objects. \line }{\i Usage:}{
|
||||
TARGET_LINK_LIBRARIES(target library1 library2 ...) Specify a list of libraries to be linked into the specified target The debug and optimized strings may be used to indicate that the next library listed is to be used only for that specific type of build
|
||||
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b UTILITY_SOURCE}{ - Specify the source tree of a third-party utility. \line }{\i Usage:}{ UTILITY_SOURCE(cache_entry executable_name path_to_source [file1
|
||||
file2 ...]) When a third-party utility's source is included in the distribution, this command specifies its location and name. The cache entry will not be set unless the path_to_source and all listed files exist. It is assumed that the source tree of the
|
||||
utility will have been built before it is needed.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b UTILITY_SOURCE}{ - Specify the source tree of a third-party utility. \line }{\i Usage:}{ UTILITY_SOURCE(cache_entry executable_name path_to_source [file1 file2 ...]) W
|
||||
hen a third-party utility's source is included in the distribution, this command specifies its location and name. The cache entry will not be set unless the path_to_source and all listed files exist. It is assumed that the source tree of the utility will
|
||||
have been built before it is needed.
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b VTK_WRAP_JAVA}{ - Create Java Wrappers. \line }{\i Usage:}{ VTK_WRAP_JAVA(resultingLibraryName SourceListName SourceLists ...)
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b VTK_WRAP_PYTHON}{ - Create Python Wrappers. \line }{\i Usage:}{ VTK_WRAP_PYTHON(resultingLibraryName SourceListName SourceLists ...)
|
||||
\par {\listtext\pard\plain\f3\fs20 \loch\af3\dbch\af0\hich\f3 \'b7\tab}}{\b VTK_WRAP_TCL}{ - Create Tcl Wrappers for VTK classes. \line }{\i Usage:}{
|
||||
|
|
@ -15852,24 +15863,24 @@ existing in the cache. If it is not a CACHE VAR, then this always writes into th
|
|||
\par }\pard \ql \li720\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin720\itap0 {
|
||||
\par }\pard\plain \s3\ql \li0\ri-720\keepn\widctlpar\aspalpha\aspnum\faauto\outlinelevel2\adjustright\rin-720\lin0\itap0 \b\fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {Adding a New Command
|
||||
\par }\pard\plain \ql \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {
|
||||
Commands can be added to CMake by deriving new commands from the class cmCommand (defined in CMake/Source/cmCommand.h/.cxx). Typically each command is im
|
||||
plemented in a class called cmRuleNameCommand stored in cmRuleNameCommand.h and cmRuleNameCommand.cxx. If you want to create a rule the best bet is to take a look at some of the existing rules in CMake. They tend to be fairly short.
|
||||
Commands can be added to CMake by deriving new commands from the class cmCommand (defined in CMake/Source/cmCommand.h/.cxx). Typically each command is implemented i
|
||||
n a class called cmRuleNameCommand stored in cmRuleNameCommand.h and cmRuleNameCommand.cxx. If you want to create a rule the best bet is to take a look at some of the existing rules in CMake. They tend to be fairly short.
|
||||
\par
|
||||
\par }\pard\plain \s3\ql \li0\ri-720\keepn\widctlpar\aspalpha\aspnum\faauto\outlinelevel2\adjustright\rin-720\lin0\itap0 \b\fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {Adding a New Makefile Generator
|
||||
\par }\pard\plain \qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {
|
||||
Different types of makefiles (corresponding to a different compiler and/or operating system) can be added by subclassing from cmMakefileGenerator (defined in cmMakefileGenerator.h/.cxx). Makefile generators process the information defined by the
|
||||
commands in CMakeLists.txt to generate the appropriate makefile(s). Again, the best bet is to work from one of the existing generators.
|
||||
\par }\pard\plain \qj \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {D
|
||||
ifferent types of makefiles (corresponding to a different compiler and/or operating system) can be added by subclassing from cmMakefileGenerator (defined in cmMakefileGenerator.h/.cxx). Makefile generators process the information defined by the commands i
|
||||
n CMakeLists.txt to generate the appropriate makefile(s). Again, the best bet is to work from one of the existing generators.
|
||||
\par }\pard \ql \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 {
|
||||
\par }\pard\plain \s1\ql \li0\ri-720\keepn\widctlpar\aspalpha\aspnum\faauto\outlinelevel0\adjustright\rin-720\lin0\itap0 \b\fs36\ul\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {Further Information
|
||||
\par }\pard\plain \ql \li0\ri-720\widctlpar\aspalpha\aspnum\faauto\adjustright\rin-720\lin0\itap0 \fs24\lang1033\langfe1033\cgrid\langnp1033\langfenp1033 {Much of the development of CMake was performed at Kitware }{\field{\*\fldinst {
|
||||
HYPERLINK "http://www.kitware.com/" }{{\*\datafield 00d0c9ea79f9bace118c8200aa004ba90b0200000003000000e0c9ea79f9bace118c8200aa004ba90b3000000068007400740070003a002f002f007700770077002e006b006900740077006100720065002e0063006f006d002f000000000000}}
|
||||
HYPERLINK "http://www.kitware.com/" }{{\*\datafield 00d0c9ea79f9bace118c8200aa004ba90b0200000003000000e0c9ea79f9bace118c8200aa004ba90b3000000068007400740070003a002f002f007700770077002e006b006900740077006100720065002e0063006f006d002f00000000000000}}
|
||||
}{\fldrslt {\cs16\ul\cf2 http://www.kitware.com/}}}{. The developers can be reached at }{\field{\*\fldinst { HYPERLINK "mailto:kitware@kitware.com" }{{\*\datafield
|
||||
00d0c9ea79f9bace118c8200aa004ba90b0200000003000000e0c9ea79f9bace118c8200aa004ba90b360000006d00610069006c0074006f003a006b0069007400770061007200650040006b006900740077006100720065002e0063006f006d000000000000}}}{\fldrslt {\cs16\ul\cf2
|
||||
00d0c9ea79f9bace118c8200aa004ba90b0200000003000000e0c9ea79f9bace118c8200aa004ba90b360000006d00610069006c0074006f003a006b0069007400770061007200650040006b006900740077006100720065002e0063006f006d00000000000000}}}{\fldrslt {\cs16\ul\cf2
|
||||
mailto:kitware@kitware.com}}}{. CMake was initially developed for the NIH/NLM Insight Segmentation and Registration Toolkit, see the Web site at }{\field{\*\fldinst {HYPERLINK "http://public.kitware.com/Insight.html"}{{\*\datafield
|
||||
00d0c9ea79f9bace118c8200aa004ba90b0200000003000000e0c9ea79f9bace118c8200aa004ba90b4e00000068007400740070003a002f002f007000750062006c00690063002e006b006900740077006100720065002e0063006f006d002f0049006e00730069006700680074002e00680074006d006c000000000000}}
|
||||
}{\fldrslt {\cs16\ul\cf2 http://public.kitware.com/Insight.html}}}{. Cmake\rquote s web page can be found at }{\field{\*\fldinst { HYPERLINK "http://public.kitware.com/CMake" }{{\*\datafield
|
||||
00d0c9ea79f9bace118c8200aa004ba90b0200000003000000e0c9ea79f9bace118c8200aa004ba90b4e00000068007400740070003a002f002f007000750062006c00690063002e006b006900740077006100720065002e0063006f006d002f0049006e00730069006700680074002e00680074006d006c00000000000000}
|
||||
}}{\fldrslt {\cs16\ul\cf2 http://public.kitware.com/Insight.html}}}{. Cmake\rquote s web page can be found at }{\field{\*\fldinst { HYPERLINK "http://public.kitware.com/CMake" }{{\*\datafield
|
||||
00d0c9ea79f9bace118c8200aa004ba90b02000000170000002000000068007400740070003a002f002f007000750062006c00690063002e006b006900740077006100720065002e0063006f006d002f0043004d0061006b0065000000e0c9ea79f9bace118c8200aa004ba90b4000000068007400740070003a002f002f00
|
||||
7000750062006c00690063002e006b006900740077006100720065002e0063006f006d002f0043004d0061006b0065000000}}}{\fldrslt {\cs16\ul\cf2 http://public.kitware.com/CMake}}}{.
|
||||
7000750062006c00690063002e006b006900740077006100720065002e0063006f006d002f0043004d0061006b006500000000}}}{\fldrslt {\cs16\ul\cf2 http://public.kitware.com/CMake}}}{.
|
||||
\par
|
||||
\par
|
||||
\par }}
|
||||
Loading…
Reference in New Issue