cmake install的使用-菜鸟笔记

2025-01-11 这里主要介绍使用cmake进行install方面的操作：通过cmake可以安装的内容可以包括目标二进制、动态库、静态库以及文件、目录、脚本等，下面分别进行简述一下：细节可以参考官网，这里简单描述一下 1.目标文件的安装 install(TARGETS targets... [EXPO

这里主要介绍使用cmake进行install方面的操作：

通过cmake可以安装的内容可以包括目标二进制、动态库、静态库以及文件、目录、脚本等，下面分别进行简述一下：

细节可以参考官网，这里简单描述一下

1.目标文件的安装

install(TARGETS targets... [EXPORT <export-name>]
        [RUNTIME_DEPENDENCIES args...|RUNTIME_DEPENDENCY_SET <set-name>]
        [[ARCHIVE|LIBRARY|RUNTIME|OBJECTS|FRAMEWORK|BUNDLE|
          PRIVATE_HEADER|PUBLIC_HEADER|RESOURCE]
         [DESTINATION <dir>]
         [PERMISSIONS permissions...]
         [CONFIGURATIONS [Debug|Release|...]]
         [COMPONENT <component>]
         [NAMELINK_COMPONENT <component>]
         [OPTIONAL] [EXCLUDE_FROM_ALL]
         [NAMELINK_ONLY|NAMELINK_SKIP]
        ] [...]
        [INCLUDES DESTINATION [<dir> ...]]
        )

下表显示了目标类型及其关联变量和内置默认值，这些默认值适用于未指定目标的情况：

目标类型	GNUInstallDirs 变量	内置默认值
`RUNTIME`	`$ { cmake_install_bindir }`	`bin`
`LIBRARY`	`${CMAKE_INSTALL_LIBDIR}`	`lib`
`ARCHIVE`	`${CMAKE_INSTALL_LIBDIR}`	`lib`
`PRIVATE_HEADER`	`$ { CMAKE_INSTALL_INCLUDEDIR }`	`include`
`PUBLIC_HEADER`	`$ { CMAKE_INSTALL_INCLUDEDIR }`	`include`

参数中的TARGETS后面跟的就是我们通过ADD_EXECUTABLE 或者ADD_LIBRARY 定义的目标文件，可能是可执行二进制、动态库、静态库。
目标类型也就相对应的有三种，ARCHIVE特指静态库，LIBRARY特指动态库，RUNTIME特指可执行目标二进制。
DESTINATION定义了安装的路径，如果路径以/开头，那么指的是绝对路径，这时候CMAKE_INSTALL_PREFIX其实就无效了.
如果你希望使用CMAKE_INSTALL_PREFIX来定义安装路径，就要写成相对路径，即不要以/开头，那么安装后的路径就是${CMAKE_INSTALL_PREFIX}/<DESTINATION定义的路径>
举个简单的例子：

INSTALL(TARGETS myrun mylib mystaticlib
RUNTIME DESTINATION bin
LIBRARY DESTINATION lib
ARCHIVE DESTINATION libstatic
)

上面的例子会将：
可执行二进制myrun 安装到${CMAKE_INSTALL_PREFIX}/bin 目录
动态库libmylib安装到${CMAKE_INSTALL_PREFIX}/lib目录
静态库libmystaticlib 安装到${CMAKE_INSTALL_PREFIX}/libstatic目录
特别注意的是你不需要关心TARGETS具体生成的路径，只需要写上TARGETS名称就可以
了。

2.普通文件安装

install(<FILES|PROGRAMS> files...
        type <type> | DESTINATION <dir>
        [PERMISSIONS permissions...]
        [CONFIGURATIONS [Debug|Release|...]]
        [COMPONENT <component>]
        [RENAME <name>] [OPTIONAL] [EXCLUDE_FROM_ALL])

`type` Argument	GNUInstallDirs Variable	build – In default
`BIN`	`$ { cmake_install_bindir }`	`bin`
`SBIN`	`${CMAKE_INSTALL_SBINDIR}`	`sbin`
`LIB`	`${CMAKE_INSTALL_LIBDIR}`	`lib`
`INCLUDE`	`$ { CMAKE_INSTALL_INCLUDEDIR }`	`include`
`SYSCONF`	`$ { CMAKE_INSTALL_SYSCONFDIR }`	`etc`
`SHAREDSTATE`	`${CMAKE_INSTALL_SHARESTATEDIR}`	`com`
`LOCALSTATE`	`${CMAKE_INSTALL_LOCALSTATEDIR}`	`var`
`RUNSTATE`	`${CMAKE_INSTALL_RUNSTATEDIR}`	`<LOCALSTATE dir>/run`
`DATA`	`${CMAKE_INSTALL_DATADIR}`	`<DATAROOT dir>`
`INFO`	`$ { cmake_install_infodir }`	`<DATAROOT dir>/info`
`LOCALE`	`$ { cmake_install_localedir }`	`<DATAROOT dir>/locale`
`MAN`	`${CMAKE_INSTALL_MANDIR}`	`<DATAROOT dir>/man`
`DOC`	`${CMAKE_INSTALL_DOCDIR}`	`<DATAROOT dir>/doc`

可用于安装一般文件，并可以指定访问权限，文件名是此指令所在路径下的相对路径。如果默认不定义权限PERMISSIONS，安装后的权限为：
OWNER_WRITE, OWNER_READ, GROUP_READ,和WORLD_READ，即 644权限。

3.目录的安装

install(DIRECTORY dirs...
        type <type> | DESTINATION <dir>
        [FILE_PERMISSIONS permissions...]
        [DIRECTORY_PERMISSIONS permissions...]
        [USE_SOURCE_PERMISSIONS] [OPTIONAL] [MESSAGE_NEVER]
        [CONFIGURATIONS [Debug|Release|...]]
        [COMPONENT <component>] [EXCLUDE_FROM_ALL]
        [FILES_MATCHING]
        [[PATTERN <pattern> | REGEX <regex>]
         [EXCLUDE] [PERMISSIONS permissions...]] [...])

这里主要介绍其中的DIRECTORY、PATTERN 以及 PERMISSIONS 参数。
DIRECTORY 后面连接的是所在Source目录的相对路径，但务必注意：abc和 abc/有很大的区别。
如果目录名不以 / 结尾，那么这个目录将被安装为目标路径下的abc，如果目录名以 / 结尾，
代表将这个目录中的内容安装到目标路径，但不包括这个目录本身。
PATTERN用于使用正则表达式进行过滤，PERMISSIONS用于指定PATTERN过滤后的文件权限。
我们来看一个例子:

INSTALL(DIRECTORY icons scripts/ DESTINATION share/myproj
PATTERN "CVS" EXCLUDE
PATTERN "scripts/*"
PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ
GROUP_EXECUTE GROUP_READ)

这条指令的执行结果是：
将icons 目录安装到 <prefix>/share/myproj，将 scripts/中的内容安装到
<prefix>/share/myproj
不包含目录名为CVS的目录，对于scripts/* 文件指定权限为 OWNER_EXECUTE
OWNER_WRITE OWNER_READ GROUP_EXECUTE GROUP_READ.

这里测试一下：根据上一篇的文章进行安装测试：

4.测试

修改根目录下的CMakeLists.txt文件如下，其实就增加了install，这里你需要先创建几个文件，才能尝试安装：

# 多个目录多个源文件 
 cmake_minimum_required(version 2.8 ) 

 project(test1 ) 
 # 遍历当前目录的所有文件并使用dir_srcs保存，也可以通过set(src_list main.c)进行指定 
 aux_source_directory ( . DIR_SRCS ) 

 # 添加生成可执行文件的保存目录 , 不会保存中间产物，如果不指定该目录则和中间产物保存在一起 
 set(executable_output_path $ { project_binary_dir}/bin ) 
 # is add 添加头文件 
 include_directories(${PROJECT_SOURCE_DIR}/include ) 
 # 这里将子目录条件到工程，并指定编译的输出产物，默认输出产物保存到build / src文件夹下 ， 
 # 如果不指定库目录保存路径同样也会保存到该路径下 
 add_subdirectory(src ) 

 # 上面定义了将src子目录加入工程，并指定编译输出(包含编译中间结果)路径为 
 # bin目录。如果不进行 bin目录的指定，那么编译结果(包括中间结果)都将存放在 
 # build / src 目录(这个目录跟原有的src目录对应)，指定 bin 目录后，相当于在编译时 
 # 将src重命名为bin，所有的中间结果和目标二进制都将存放在bin目录 。 

 # 指定生成目标 
 add_executable(test1 main.cpp ) 

 # 添加链接库 
 # 把子目录集src的编译成的库文件链接到这里 
 target_link_libraries(test1 add ) 

 message(status   $ { project_source_dir } " ------完成编译和链接生成可执行文件----- " ) 

 # 添加安装信息如copyright readme 
 install(files copyright readme.md destination share / doc / cmake / test ) 
 # 安装runtest.sh 
 install(programs runtest.sh DESTINATION bin ) 

 # 这里按照doc目录下的文件 
 install(directory doc/ destination share / doc / cmake / test )

进入build，执行如下命令：

cmake -DCMAKE_INSTALL_PREFIX=/home/ubuntu/work/usr ..
make
make install

这是只是测试使用，因此安装在home/ubuntu/work/usr下，也可以默认安装，默认安装的路径为：

如果我没有定义cmake_install_prefix会安装到什么地方？
你可以尝试以下，cmake ..;make;make install，你会发现
CMAKE_INSTALL_PREFIX的默认定义是/usr/local