1. cmake_minimum_required()

# 指定CMake 最低版本号
cmake_minimum_required (VERSION 3.0)

2. project()

# 指定工程名。编译的target在工程内部可见。
project (demo)

3. message()

# 打印调试信息
message (STATUS "INCLUDE_DIR:" ${INCLUDE_DIRS})

4. set()

set()应用广泛。下面是几种常见的用途：

# 指定include文件目录列表
set (INC_DIRS
     ../include
     .)

# 指定源文件列表：
set (SRCS
     a.cpp
     b.cpp)

# 指定链接库列表
set (LIBS
     arithm
     rt)

# 定义头文件目录，方便其他模块使用
set (ARITHM_INCLUDE_DIR 
     {CMAKE_SOURCE_DIR}/common/arithm/include)

# 定义链接库的名字，方便其他模块引用
set (ARITHM_LIBRARY 
     arithm)

5. add_library()

编译库target。一般编译如下两种库：STATIC指定编译静态库，SHARED指定编译动态库

add_library (arithm STATIC ${SRCS})
add_library (arithm SHARED ${SRCS})

6. add_executabl()

编译可执行程序target。

# 编译可执行程序
add_executable (hello ${SRCS})

7. add_definitions()

加入预编译宏：

add_definitions(-DDEBUG)

这样在C++代码中就可以有条件地编译某段代码：

#ifdef DEBUG
//
// 仅在定义了DEBUG时有效的代码
//
#endif

8. include_directories()

编译target时指定include文件目录。

include_directories (${INC_DIRS)

9. target_link_libraries()

编译target时指定链接库。

target_link_libraries (hello ${LIBS})

10. set_target_properties()

有时target需要额外的编译选项支持，比如多线程，就添加-pthread链接选项。

 set_target_properties (hello PROPERTIES LINK_FLAGS "-pthread")

11. install()

如下所示，install()的目标有几种。

# 安装指定文件,如配置文件
install (FILES hello/etc/hello.json
         DESTINATION etc)

# 如果有多个文件需要安装，也可以安装目录下的所有文件。比如include目录下的文件：
install (DIRECTORY hello/include/
            DESTINATION include/hello)

# 或者将目录也一同安装，比如json目录及下面的文件：
install (DIRECTORY hello/include/json
            DESTINATION include/hello)

# 安装二进制程序
install (TARGETS hello
             DESTINATION bin)

# 安装动态库
install (TARGETS hello
             DESTINATION lib)

# 安装静态库
install (TARGETS hello
             DESTINATION lib)

# 安装脚本
install (PROGRAMS start.sh
            DESTINATION bin)

可以用选项CMAKE_INSTALL_PREFIX指定安装的根目录:

cmake -DCMAKE_INSTALL_PREFIX=~/usr .

12. add_subdirectory()

一个工程可能由若干库和程序组成，一般把它们放在各自的目录下。add_subdirectory()可以增加目录层次。

add_subdiretory (arithm)
add_subdirectory(hello)

13. file()

file()用于文件读写。下面的命令将Version.h的内容读入变量VERSION_STR。

file (READ Version.h VERSION_STR)

14. string()

string() 是字符串操作。下面的命令用指定的正则表达式格式，从前面的VERSION_STR解析出变量VERSION_MAJOR。

string (REGEX REPLACE ".*#define +VERSION_MAJOR +([0-9]+).*" "\\1"  VERSION_MAJOR  "${VERSION_STR}")

15. if()，else() 和 if()

CMake支持分支语句。

if (VERSION_MAJOR STREQUAL "")
  message(FATAL_ERROR "Invalid version major.")
else()
  message(STATUS "version major: ${VERSION_MAJOR}")
endif()

16. include()

include可以引入CMake本身的模块，也可以引入自己写的模块。有了include，CMake的功能就可以无限扩展了。

有些常用的CMake模块的例子，比如用于编译第三方软件的ExternalProject，用于打包的CPack等等。

# Add3thPartyModules.cmake是自己写的脚本，调用ExternalProject模块构建一组第三方软件
include (Add3thPartyModules.cmake)

# 打包
include (CPack)

CMake自带的模块一般在如下的目录下。

/usr/share/cmake-/Modules/
/usr/share/cmake/Modules/

使用如下命令可以得到当前的Module列表。

cmake --help-module-list

16. option()

option给CMake脚本的使用者提供一个选项，以便改变程序的行为。

下面的例子定义选项USE_MYMATH。如果使用者开启这个开关，则编译MathFunctions库，并链接它。USE_MYMATH的缺省值为ON。

option (USE_MYMATH 
        "Use tutorial provided math implementation" ON) 

if (USE_MYMATH)
  include_directories (“${PROJECT_SOURCE_DIR}/MathFunctions”)
  add_subdirectory (MathFunctions)
  set (EXTRA_LIBS ${EXTRA_LIBS} MathFunctions)
endif (USE_MYMATH)

使用者指定选项的方式如下：

cmake -DUSE_MYMATH=OFF .

17. out-of-source build

除了in-source build, CMake还支持out-of-source build，也就是构建目录与源文件目录是不同的目录。

cd ../build
cmake ../demo

CMake定义了两个变量：CMAKE_SOURCE_DIR指向源码目录，CMAKE_BINARY_DIR指向build目录。可以基于它们得到头文件目录和库路径等。

18. Debug/Release模式

可以用选项CMAKE_BUILD_TYPE指定编译模式，CMake支持Debug，Release， RelWithDebInfo和MinSizeRel模式：

cmake -DCMAKE_BUILD_TYPE=Debug .

这最终会影响到gcc/g++的编译选项：是否包含符号信息，是否优化，和优化的级别。

19. 打印CMake构建信息

如果觉得CMake构建过程的信息不够详细，可以设置变量CMAKE_VERBOSE_MAKEFILE，要求打印更详细的信息。

set (CMAKE_VERBOSE_MAKEFILE ON)

20. 打印编译命令

默认情况下，CMake 生成的Makefile不打印编译过程中的命令。可以指定VERBOSE变量要求打印：

cmake .
VERBOSE=1 make

参考资料

.SILENT用法

CMake 常用法