summaryrefslogtreecommitdiffstats
path: root/CMakeScripts/Pod2man.cmake
diff options
context:
space:
mode:
Diffstat (limited to 'CMakeScripts/Pod2man.cmake')
-rw-r--r--CMakeScripts/Pod2man.cmake83
1 files changed, 83 insertions, 0 deletions
diff --git a/CMakeScripts/Pod2man.cmake b/CMakeScripts/Pod2man.cmake
new file mode 100644
index 0000000..7405ad5
--- /dev/null
+++ b/CMakeScripts/Pod2man.cmake
@@ -0,0 +1,83 @@
+# Use pod2man to generate manual pages from .pod files
+
+# Usage: pod2man(<podfile> <release-string> <man-section> <heading-center-text>)
+#
+# E.g.: pod2man("/path/to/file/mypod.pod" "1.2.3" 1 "My Manual Pages")
+
+include(GNUInstallDirs)
+
+find_program(POD2MAN pod2man)
+if(NOT POD2MAN)
+ message(STATUS "Could not find pod2man - man pages disabled")
+endif()
+
+find_program(GZIP gzip)
+if(NOT GZIP)
+ message(STATUS "Could not find gzip - man pages uncompressed")
+endif()
+
+macro(pod2man PODFILE_FULL RELEASE SECTION CENTER)
+ get_filename_component(PODFILE ${PODFILE_FULL} NAME)
+ string(REPLACE "." ";" PODFILE_LIST ${PODFILE})
+ list(GET PODFILE_LIST 0 NAME)
+ list(GET PODFILE_LIST 1 LANG)
+ string(TOUPPER ${NAME} NAME_UPCASE)
+ if(${LANG} STREQUAL "pod")
+ set(LANG "")
+ endif()
+
+ if(NOT EXISTS ${PODFILE_FULL})
+ message(FATAL_ERROR "Could not find pod file ${PODFILE_FULL} to generate man page")
+ endif(NOT EXISTS ${PODFILE_FULL})
+
+ if(POD2MAN)
+ if(LANG)
+ set(MANPAGE_TARGET "man-${NAME}-${LANG}")
+ set(MANFILE_TEMP "${CMAKE_CURRENT_BINARY_DIR}/${NAME}.${LANG}.tmp")
+ set(MANFILE_FULL "${CMAKE_CURRENT_BINARY_DIR}/${NAME}.${LANG}.${SECTION}")
+ set(MANFILE_FULL_GZ "${CMAKE_CURRENT_BINARY_DIR}/${NAME}.${LANG}.${SECTION}.gz")
+ set(MANFILE_DEST "${CMAKE_INSTALL_MANDIR}/${LANG}/man${SECTION}")
+ else()
+ set(MANPAGE_TARGET "man-${NAME}")
+ set(MANFILE_TEMP "${CMAKE_CURRENT_BINARY_DIR}/${NAME}.tmp")
+ set(MANFILE_FULL "${CMAKE_CURRENT_BINARY_DIR}/${NAME}.${SECTION}")
+ set(MANFILE_FULL_GZ "${CMAKE_CURRENT_BINARY_DIR}/${NAME}.${SECTION}.gz")
+ set(MANFILE_DEST "${CMAKE_INSTALL_MANDIR}/man${SECTION}")
+ endif()
+ add_custom_command(
+ OUTPUT ${MANFILE_TEMP}
+ COMMAND ${POD2MAN} --utf8 --section="${SECTION}" --center="${CENTER}"
+ --release="${RELEASE}" --name="${NAME_UPCASE}" "${PODFILE_FULL}" "${MANFILE_TEMP}"
+ )
+
+ add_custom_command(
+ OUTPUT ${MANFILE_FULL}
+ COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/fix-roff-punct "${MANFILE_TEMP}" > ${MANFILE_FULL}
+ DEPENDS ${MANFILE_TEMP}
+ )
+ if(GZIP AND WITH_MANPAGE_COMPRESSION)
+ add_custom_command(
+ OUTPUT ${MANFILE_FULL_GZ}
+ COMMAND ${GZIP} -f -k --best -n "${MANFILE_FULL}"
+ DEPENDS ${MANFILE_FULL}
+ )
+ add_custom_target(${MANPAGE_TARGET} ALL
+ DEPENDS ${MANFILE_FULL_GZ}
+ )
+ install(
+ FILES ${MANFILE_FULL_GZ}
+ RENAME ${NAME}.${SECTION}.gz
+ DESTINATION ${MANFILE_DEST}
+ )
+ else()
+ add_custom_target(${MANPAGE_TARGET} ALL
+ DEPENDS ${MANFILE_FULL}
+ )
+ install(
+ FILES ${MANFILE_FULL}
+ RENAME ${NAME}.${SECTION}
+ DESTINATION ${MANFILE_DEST}
+ )
+ endif()
+ endif()
+endmacro(pod2man PODFILE NAME SECTION CENTER)