From 8032e89d33f7d0505a9953546ccf567444166603 Mon Sep 17 00:00:00 2001
From: Dan Nicholson <dbn@endlessos.org>
Date: Fri, 8 Apr 2022 16:51:59 -0600
Subject: [PATCH] man: Create an HTML index

This provides something that can serve at the root of the HTML man pages
tree.
---
 Makefile-man.am |   5 +-
 man/index.xml   | 202 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 206 insertions(+), 1 deletion(-)
 create mode 100644 man/index.xml

diff --git a/Makefile-man.am b/Makefile-man.am
index 3f941bed..5c7f2413 100644
--- a/Makefile-man.am
+++ b/Makefile-man.am
@@ -19,6 +19,8 @@
 
 if ENABLE_MAN
 
+# If you add a new man page here, add a reference to it in index.xml and
+# ostree.xml.
 man1_files = ostree.1 ostree-admin-cleanup.1				\
 ostree-admin-config-diff.1 ostree-admin-deploy.1			\
 ostree-admin-init-fs.1 ostree-admin-instutil.1 ostree-admin-os-init.1	\
@@ -53,6 +55,7 @@ man1_MANS = $(addprefix man/,$(man1_files))
 man5_MANS = $(addprefix man/,$(man5_files))
 
 manhtml_files = \
+	man/html/index.html \
 	$(addprefix man/html/,$(man1_files:.1=.html)) \
 	$(addprefix man/html/,$(man5_files:.5=.html)) \
 	$(NULL)
@@ -65,7 +68,7 @@ manhtml: $(manhtml_files)
 .PHONY: manhtml
 endif
 
-EXTRA_DIST += $(man1_MANS:.1=.xml) $(man5_MANS:.5=.xml)
+EXTRA_DIST += man/index.xml $(man1_MANS:.1=.xml) $(man5_MANS:.5=.xml)
 
 XSLT_MAN_STYLESHEET = http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl
 XSLT_HTML_STYLESHEET = man/html.xsl
diff --git a/man/index.xml b/man/index.xml
new file mode 100644
index 00000000..e20ae871
--- /dev/null
+++ b/man/index.xml
@@ -0,0 +1,202 @@
+<?xml version='1.0'?> <!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+    "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+
+<!--
+Copyright © 2022 Endless OS Foundation LLC
+
+SPDX-License-Identifier: LGPL-2.0+
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library. If not, see <https://www.gnu.org/licenses/>.
+-->
+
+<index id="index">
+    <title>OSTree Manual</title>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-admin-cleanup</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-admin-config-diff</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-admin-deploy</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-admin-init-fs</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-admin-instutil</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-admin-os-init</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-admin-pin</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-admin-set-origin</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-admin-status</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-admin-switch</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-admin-undeploy</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-admin-unlock</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-admin-upgrade</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-admin</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-cat</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-checkout</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-checksum</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-commit</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-config</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-create-usb</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-diff</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-export</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-find-remotes</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-fsck</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-gpg-sign</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-init</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-log</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-ls</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-prune</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-pull-local</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-pull</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-refs</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-remote</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree.repo-config</refentrytitle><manvolnum>5</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree.repo</refentrytitle><manvolnum>5</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-reset</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-rev-parse</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-show</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-sign</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-static-delta</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-summary</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>ostree-trivial-httpd</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+
+    <indexentry><primaryie><citerefentry>
+        <refentrytitle>rofiles-fuse</refentrytitle><manvolnum>1</manvolnum>
+    </citerefentry></primaryie></indexentry>
+</index>