diff options
| -rw-r--r-- | CMakeLists.txt | 29 | ||||
| -rw-r--r-- | README.adoc | 3 | ||||
| -rw-r--r-- | xB.adoc | 4 | ||||
| -rw-r--r-- | xC.adoc | 4 |
4 files changed, 26 insertions, 14 deletions
diff --git a/CMakeLists.txt b/CMakeLists.txt index 6ffe9b9..4b403f3 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -204,20 +204,31 @@ install (DIRECTORY plugins/xC/ # Generate documentation from text markup find_program (ASCIIDOCTOR_EXECUTABLE asciidoctor) -if (NOT ASCIIDOCTOR_EXECUTABLE) - message (FATAL_ERROR "asciidoctor not found") +find_program (A2X_EXECUTABLE a2x) +if (NOT ASCIIDOCTOR_EXECUTABLE AND NOT A2X_EXECUTABLE) + message (FATAL_ERROR "Neither asciidoctor nor a2x were found") endif () foreach (page xB xC xD) set (page_output "${PROJECT_BINARY_DIR}/${page}.1") list (APPEND project_MAN_PAGES "${page_output}") - add_custom_command (OUTPUT ${page_output} - COMMAND ${ASCIIDOCTOR_EXECUTABLE} -b manpage - -a release-version=${project_version} - "${PROJECT_SOURCE_DIR}/${page}.adoc" - -o "${page_output}" - DEPENDS ${page}.adoc - COMMENT "Generating man page for ${page}" VERBATIM) + if (ASCIIDOCTOR_EXECUTABLE) + add_custom_command (OUTPUT ${page_output} + COMMAND ${ASCIIDOCTOR_EXECUTABLE} -b manpage + -a release-version=${project_version} + -o "${page_output}" + "${PROJECT_SOURCE_DIR}/${page}.adoc" + DEPENDS ${page}.adoc + COMMENT "Generating man page for ${page}" VERBATIM) + elseif (A2X_EXECUTABLE) + add_custom_command (OUTPUT ${page_output} + COMMAND ${A2X_EXECUTABLE} --doctype manpage --format manpage + -a release-version=${project_version} + -D "${PROJECT_BINARY_DIR}" + "${PROJECT_SOURCE_DIR}/${page}.adoc" + DEPENDS ${page}.adoc + COMMENT "Generating man page for ${page}" VERBATIM) + endif () endforeach () add_custom_target (docs ALL DEPENDS ${project_MAN_PAGES}) diff --git a/README.adoc b/README.adoc index da7f3e7..2c1df33 100644 --- a/README.adoc +++ b/README.adoc @@ -71,7 +71,8 @@ a package with the latest development version from Archlinux's AUR. Building -------- -Build dependencies: CMake, pkg-config, asciidoctor, awk, liberty (included) + +Build dependencies: CMake, pkg-config, asciidoctor or asciidoc, awk, + liberty (included) + Runtime dependencies: openssl + Additionally for 'xC': curses, libffi, lua >= 5.3 (optional), readline >= 6.0 or libedit >= 2013-07-12 @@ -65,9 +65,9 @@ for RPC, with the following subcommands: exists, the value will be empty. The response will be delivered in the following format: + -``` +.... XB :value -``` +.... + This is particularly useful for retrieving the *prefix* string. @@ -25,9 +25,9 @@ Options other formatting marks to ANSI codes retrieved from the *terminfo*(5) database: + -``` +.... printf '\x02bold\x02\n' | xC -f -``` +.... + This feature may be used to preview server MOTD files. |