aboutsummaryrefslogtreecommitdiff
path: root/contrib/unbound/doc/README.man
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/unbound/doc/README.man')
-rw-r--r--contrib/unbound/doc/README.man16
1 files changed, 16 insertions, 0 deletions
diff --git a/contrib/unbound/doc/README.man b/contrib/unbound/doc/README.man
new file mode 100644
index 000000000000..8e7897f47790
--- /dev/null
+++ b/contrib/unbound/doc/README.man
@@ -0,0 +1,16 @@
+After Unbound 1.23.0, the source of the man pages is in reStructuredText format.
+
+This helps with the online documentation at https://unbound.docs.nlnetlabs.nl
+and makes it easier to maintain and contribute to the documentation.
+
+The templated man pages (*.in) are still part of the code repository as to not
+alter current procedures that could be in place by users/packagers.
+
+The templated man pages (*.in) are generated by Sphinx (used for the online
+documentation).
+The online documentation has its own repository at
+https://github.com/NLnetLabs/unbound-manual.
+
+In the README.md there (branch test-auto for now), there are further simple
+instructions on how to generate the templated man pages there and update them
+in this repository.