matrixion/man/CMakeLists.txt
tastytea 3e8734dbd5
Add man page (#851)
This adds a man page which lists command line options, key bindings and
commands. A new CMake option `MAN` is added, enabled by default on
`UNIX` but not `APPLE`.

The man pages are generated with either `a2x` (from asciidoc) or
`asciidoctor`. If both are not found, a fatal error is signaled.
2021-12-22 21:34:07 +00:00

48 lines
1.5 KiB
CMake

# Uses either a2x from asciidoc or asciidoctor to compile the man page.
include(GNUInstallDirs)
configure_file("${PROJECT_NAME}.1.adoc.in" "${PROJECT_NAME}.1.adoc" @ONLY)
find_program (ASCIIDOC_COMPILER a2x)
if (NOT ASCIIDOC_COMPILER)
find_program (ASCIIDOCTOR_COMPILER asciidoctor)
if(NOT ASCIIDOCTOR_COMPILER)
message(FATAL_ERROR
"Could not find asciidoc (a2x) or asciidoctor. "
"Man page generation not possible.")
endif()
endif()
if(ASCIIDOC_COMPILER)
message(STATUS "Using asciidoc compiler at ${ASCIIDOC_COMPILER}")
add_custom_command(
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.1"
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
DEPENDS "${PROJECT_NAME}.1.adoc"
COMMAND "${ASCIIDOC_COMPILER}"
ARGS
"--doctype=manpage"
"--format=manpage"
"--no-xmllint"
"${PROJECT_NAME}.1.adoc")
endif()
if(ASCIIDOCTOR_COMPILER)
message(STATUS "Using asciidoctor compiler at ${ASCIIDOCTOR_COMPILER}")
add_custom_command(
OUTPUT "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.1"
WORKING_DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}"
DEPENDS "${PROJECT_NAME}.1.adoc"
COMMAND "${ASCIIDOCTOR_COMPILER}"
ARGS "--backend=manpage" "--doctype=manpage" "${PROJECT_NAME}.1.adoc")
endif()
if(ASCIIDOC_COMPILER OR ASCIIDOCTOR_COMPILER)
add_custom_target(man ALL DEPENDS "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.1")
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.1
DESTINATION ${CMAKE_INSTALL_MANDIR}/man1)
endif()