Add man-html

Author: dmnks

CMakeLists.txt

@@ -314,6 +314,9 @@ mark_as_advanced(FIND_DEBUGINFO)
 find_program(SCDOC NAMES scdoc REQUIRED)
 mark_as_advanced(SCDOC)
 
+find_program(SCD2HTML NAMES scd2html)
+mark_as_advanced(SCD2HTML)
+
 function(chkdef func req)
 	string(TOUPPER ${func} FUNC)
 	set(HAVENAME HAVE_${FUNC})

docs/_config.yml

@@ -9,3 +9,7 @@ plugins:
 #  - jekyll-readme-index
   - jekyll-titles-from-headings
   - jekyll-relative-links
+
+collections:
+  man:
+    output: true

docs/man/CMakeLists.txt

@@ -19,6 +19,20 @@ foreach(man ${manuals})
 endforeach()
 add_custom_target(man ALL DEPENDS ${manuals})
 
+# Render all manuals in HTML
+configure_file(mkpage.in mkpage @ONLY)
+set(htmldir ${CMAKE_BINARY_DIR}/docs/_man)
+set(htmlfiles "")
+file(MAKE_DIRECTORY ${htmldir})
+foreach(man ${manuals})
+	set(file ${htmldir}/${man}.html)
+	add_custom_command(OUTPUT ${file}
+		COMMAND ./mkpage ${CMAKE_CURRENT_SOURCE_DIR}/${man}.scd ${file}
+		DEPENDS ${man}.scd)
+	list(APPEND htmlfiles ${file})
+endforeach()
+add_custom_target(man-html ALL DEPENDS ${htmlfiles})
+
 # Install manuals for the enabled features
 set(manuals ${core})
 if (ENABLE_PLUGINS)

docs/man/index.md

@@ -2,32 +2,20 @@
 layout: default
 title: rpm.org - RPM Manual Pages
 ---
+
+{% assign tools = site.man      | where: 'topic', 'tool' %}
+{% assign plugins = site.man    | where: 'topic', 'plugin' %}
+
 # RPM Manual Pages
 
 ## Tools
-* [rpm (8)](rpm.8.scd)
-* [rpm-misc (8)](rpm-misc.8.scd)
-* [rpmbuild (1)](rpmbuild.1.scd)
-* [rpmdeps (1)](rpmdeps.1.scd)
-* [rpmdb (8)](rpmdb.8.scd)
-* [rpmgraph (1)](rpmgraph.1.scd)
-* [rpmkeys (8)](rpmkeys.8.scd)
-* [rpmlua (1)](rpmlua.1.scd)
-* [rpmsign (1)](rpmsign.1.scd)
-* [rpmsort (1)](rpmsort.1.scd)
-* [rpmspec (1)](rpmspec.1.scd)
-* [rpm2archive (1)](rpm2archive.1.scd)
-* [rpm2cpio (1)](rpm2cpio.1.scd)
-* [gendiff (1)](gendiff.1.scd)
 
-## RPM Plugins
-* [rpm-plugins (8)](rpm-plugins.8.scd)
-* [rpm-plugin-audit (8)](rpm-plugin-audit.8.scd)
-* [rpm-plugin-dbus-announce (8)](rpm-dbus-announce.8.scd)
-* [rpm-plugin-fapolicyd (8)](rpm-plugin-fapolicyd.8.scd)
-* [rpm-plugin-ima (8)](rpm-plugin-ima.8.scd)
-* [rpm-plugin-prioreset (8)](rpm-plugin-prioreset.8.scd)
-* [rpm-plugin-selinux (8)](rpm-plugin-selinux.8.scd)
-* [rpm-plugin-syslog (8)](rpm-plugin-syslog.8.scd)
-* [rpm-plugin-systemd-inhibit (8)](rpm-plugin-systemd-inhibit.8.scd)
-* [rpm-plugin-unshare (8)](rpm-plugin-unshare.8.scd)
+{% for page in tools -%}
+- [{{ page.name }}]({{ page.filename }})
+{% endfor %}
+
+## Plugins
+
+{% for page in plugins -%}
+- [{{ page.name }}]({{ page.filename }})
+{% endfor %}

docs/man/mkpage.in

@@ -0,0 +1,37 @@
+#!/bin/bash
+#
+# Create a Jekyll-compatible HTML page from the given scdoc(5) file
+# Usage: ./mkpage <input.scd> <output.html>
+
+SCD_FILE=$1
+OUT_FILE=$2
+SCD_BASE=$(basename $SCD_FILE)
+NAME=$(echo "$SCD_BASE" | sed 's/^\(.\+\)\.\(.\+\)\.html$/\1(\2)/')
+
+category() {
+    case $1 in
+        rpm-plugin*)    echo plugin ;;
+        *)              echo tool ;;
+    esac
+}
+
+PREAMBLE="\
+---
+layout: default
+title: rpm.org - $NAME
+filename: $SCD_BASE
+category: $(category $NAME)
+name: $NAME
+---
+
+<style type="text/css">
+  h2 a, h3 a {
+    font-size: 16px;
+    vertical-align: text-top;
+  }
+</style>
+"
+
+@SCD2HTML@ -f < $SCD_FILE | cat <(echo "$PREAMBLE") - > $OUT_FILE
+# Convert man page references to links
+sed -i 's|<b>\(rpm[^<]*\)</b>(\(.\))|<a href="\1.\2.html">\1(\2)</a>|g' $OUT_FILE