cmake：命令行工具cpack

概要

cpack [<options>]

描述

• cpack可执行文件是CMake打包程序。它以各种格式生成安装程序和源程序包。
• 对于每个安装程序或包格式，cpack都有一个特定的后端，称为“生成器”。生成器负责生成所需的输入并调用特定的包创建工具。不要将这些安装程序或包生成器与cmake命令的makefile生成器混淆。
  • cpack generators手册中指定了所有支持的生成器。
  • cpack–help命令打印目标平台支持的生成器列表。
  • 可以通过CPACK_GENERATOR变量或命令行选项-G来选择要使用哪一个。

• cpack程序由用CMake语言编写的配置文件控制。除非通过命令行选项–config进行不同的选择，否则将使用当前目录中的CPackConfig.cmake文件。
• 在标准CMake工作流中，如果CPack模块包含在项目的CMakeLists.txt文件中，则文件CPackConfig.CMake由CMake可执行文件生成。

Options

-G <generators>

• < generators>是一个分号分隔的生成器名称列表。cpack将遍历此列表，并根据CPackConfig.cmake配置文件中提供的详细信息以该生成器的格式生成包。
• 如果没有给出此选项，则CPACK_GENERATOR变量决定将使用的默认生成器集。

-C <configs>

• 指定要打包的项目配置 (例如 Debug, Release, etc.), 其中是以分号分隔的列表。.
• 当CMake项目使用多配置生成器（如Xcode或visualstudio）时，需要使用此选项来告诉cpack包中要包含哪些生成的可执行文件。用户负责确保在调用cpack之前已经构建了列出的配置。

-D <var>=<value>

• 设置CPack变量。这将覆盖cpack读取的输入文件中为设置的任何值。

--config <configFile>

• 指定cpack读取的配置文件以提供打包详细信息。默认情况下，将使用当前目录中的CPackConfig.cmake。

--verbose, -V

• 使用详细输出运行cpack。这可以用来显示包生成工具的更多细节，适合于项目开发人员。

--debug

• 运行带有调试输出的cpack。该选项主要针对cpack本身的开发人员，通常项目开发人员不需要。

--trace

• 将底层cmake脚本置于跟踪模式。

--trace-expand

• 将底层cmake脚本置于展开跟踪模式。

-P <packageName>

• 覆盖/定义用于打包的CPACK_PACKAGE_NAME变量的值。
• 它将覆盖CPackConfig.cmake文件中为此变量设置的任何值。

-R <packageVersion>

• 覆盖/定义用于打包的CPACK_PACKAGE_VERSION变量的值。
• 它将覆盖CPackConfig.cmake文件中设置的值，或根据 CPACK_PACKAGE_VERSION_MAJOR, CPACK_PACKAGE_VERSION_MINOR and CPACK_PACKAGE_VERSION_PATCH.自动计算的值

-B <packageDirectory>

• 覆盖/定义CPACK_PACKAGE_DIRECTORY，它控制CPack执行打包工作的目录。
• 默认情况下，生成的包将在此位置创建，并在此目录下创建_CPack_Packages子目录，作为包创建过程中的工作区域。

--vendor <vendorName>

• 覆盖/定义 CPACK_PACKAGE_VENDOR.

--help,-help,-usage,-h,-H,/?

• 打印使用信息并退出。
• 用法描述基本的命令行界面及其选项。

--version,-version,/V [<f>]

• 显示程序名称/版本标题并退出。
• 如果指定了一个文件，则将版本写入其中。如果给出< f>，将打印到指定的file。

--help-full [<f>]

• 打印所有帮助手册并退出。
• 所有手册都以人类可读的文本格式打印。如果给出< f>，将打印到指定的ile。

--help-manual <man> [<f>]

• 打印一个帮助手册并退出。
• 手册都以人类可读的文本格式打印。如果给出< f>，将打印到指定的file。

--help-manual-list [<f>]

• 列出可用的帮助手册并退出。
• 手册都以人类可读的文本格式打印。如果给出< f>，将打印到指定的file。

--help-command <cmd> [<f>]

• 打印一个命令的帮助手册并退出。
• 手册都以人类可读的文本格式打印。如果给出< f>，将打印到指定的file。

--help-command-list [<f>]

• 列出有帮助的命令并退出。
• 手册都以人类可读的文本格式打印。如果给出< f>，将打印到指定的file。

--help-commands [<f>]

• 打印 cmake-commands手册并退出。
• 手册都以人类可读的文本格式打印。如果给出< f>，将打印到指定的file。

--help-module <mod> [<f>]

• 打印一个模块的帮助并退出。
• cmake-modules(7) 以人类可读的文本格式打印。如果给出< f>，将打印到指定的file。