使用 cmake 生成手册页/打包/安装

Question

我正在寻找一些关于如何使用 CMake 在项目中生成、打包和安装手册页的好示例/教程。

Answer 1

对于 Linux 下的 cmake 2.8.12，以下内容对我有用：

ADD_CUSTOM_TARGET(man ALL)

ADD_CUSTOM_COMMAND(
  TARGET man
  SOURCE ${CMAKE_CURRENT_SOURCE_DIR}/myprog.pod
  COMMAND pod2man ARGS -s 1 -c "myprog manual" ${CMAKE_CURRENT_SOURCE_DIR}/myprog.pod ${CMAKE_CURRENT_BINARY_DIR}/myprog.1
  OUTPUTS ${CMAKE_CURRENT_BINARY_DIR}/myprog.1
)

ADD_CUSTOM_COMMAND(
  TARGET man
  SOURCE man
  DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/myprog.1
)

INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/myprog.1 DESTINATION ${CMAKE_INSTALL_PREFIX}/man/man1)

即使按照 CMake 标准，它看起来也不优雅。我希望看到一个更少口吃的解决方案。

Answer 2

也许您会对以下解决方案感兴趣，它允许生成和安装用 Markdown 或 AsciiDoc 编写的手册页：

https://github.com/rnpgp/cmake-modules/

要生成并安装用 Markdown 编写的手册页，只需在 CMakeLists.txt 中添加两行：

include(PandocMan)
add_pandoc_man("${CMAKE_CURRENT_SOURCE_DIR}/utility.1.md")

与 AsciiDoc 和 AsciiDoctor 相同：

include(AdocMan)
add_adoc_man("${CMAKE_CURRENT_SOURCE_DIR}/utility.1.adoc")

Answer 3

这是一个非常简单的解决方案，适用于 deb 和 rpm 软件包：

install(FILES manfile.1 TYPE MAN)

可以在此处找到官方文档：
https://cmake.org/cmake/help/latest/command/ install.html#install
查找大小写匹配的单词 TYPE。

Answer 4

您可以深入研究 CMake 本身的源代码树，了解它如何安装自己的手册页。

它肯定是以下组合：

• 使用 CMake 的 add_custom_command
• 调用工具在这些自定义命令中生成/生成文档
• 将结果安装在正确的位置

有关详细信息，请参阅 CMake 的 add_custom_command 和安装命令的文档：

• http://cmake.org/cmake/help/cmake-2-8-docs。 html#command:add_custom_command
• http:// cmake.org/cmake/help/cmake-2-8-docs.html#command:install