Adding command line options to CMake

Question

I'm building a large library using CMake, and I would like users to be able to selectively enable/disable certain parts of my build process.

How can I add command-line options to my CMake build, e.g. so that users may type something like cmake --build-partone --nobuild-parttwo --dothis=true --dothat=false ..?

Apparently the OPTION keyword will create variables that can be set from the CMake GUI, but I can't figure out how to do this from the command line.

Thank you for your question as it answered my question with regards to the purpose of cmake option. So, i see now it is for GUI — eigenfield, Aug 04 '20 at 18:09

score 174 · Accepted Answer · edited Sep 10 '18 at 21:14

174

Yeah, you should use the option command. You can set options from the command line this way:

//CMakeLists.txt
option(MyOption "MyOption" OFF)

//Command line
cmake -DMyOption=ON MyProjectFolder

Note that -DMyOption must come before the path.

edited Sep 10 '18 at 21:14

Peter Mortensen

30,030
21
100
124

answered May 14 '11 at 07:30

beduin

7,473
3
26
24

5

... and `cmake MyProjectFolder -DMyOption` does not turn the option on (or off) – mabraham Mar 26 '13 at 13:36
put -DMyOption before MyProjectFolder and take a try? – updogliu Feb 16 '14 at 01:08
11

Use `-DMyOption=ON` or `-DMyOption=OFF` to turn on or off. – kvanbere Nov 01 '14 at 03:18
I just noticed as I was trying to build a third party module that items set with "set(NAME blahblah)" in CMakeLists.txt are overridable with -DNAME=overridingValue on the cmake command line, – peterk Dec 20 '18 at 22:01

score 17 · Answer 2 · edited Sep 10 '18 at 21:15

17

Just a little correction:

If you have other variables to pass, it is recommended to indicate the type of these:

//CMakeLists.txt
option(MyOption "MyOption" OFF)

//Command line
cmake -DMyOption:BOOL=ON MyProjectFolder -D...

edited Sep 10 '18 at 21:15

Peter Mortensen

30,030
21
100
124

answered Apr 04 '15 at 08:43

guilloptero

1,525
1
10
6

Adding command line options to CMake

2 Answers2

Linked

Related