build manpages from docbook

Makefile.top

@@ -77,3 +77,32 @@ LIBLTDL_CFLAGS = \
 
 LIBLTDL_LIBS = \
 	$(top_builddir)/libltdl/libltdlc.la
+
+SUFFIXES: .docbook .html .1 .2 .3 .4 .5 .6 .7 .8
+
+.docbook.html:
+	${XSLTPROC} -o $@ ${top_srcdir}/doc/xsl/isc-docbook-html.xsl $<
+
+.docbook.1:
+	${XSLTPROC} -o $@ ${top_srcdir}/doc/xsl/isc-manpage.xsl $<
+
+.docbook.2:
+	${XSLTPROC} -o $@ ${top_srcdir}/doc/xsl/isc-manpage.xsl $<
+
+.docbook.3:
+	${XSLTPROC} -o $@ ${top_srcdir}/doc/xsl/isc-manpage.xsl $<
+
+.docbook.4:
+	${XSLTPROC} -o $@ ${top_srcdir}/doc/xsl/isc-manpage.xsl $<
+
+.docbook.5:
+	${XSLTPROC} -o $@ ${top_srcdir}/doc/xsl/isc-manpage.xsl $<
+
+.docbook.6:
+	${XSLTPROC} -o $@ ${top_srcdir}/doc/xsl/isc-manpage.xsl $<
+
+.docbook.7:
+	${XSLTPROC} -o $@ ${top_srcdir}/doc/xsl/isc-manpage.xsl $<
+
+.docbook.8:
+	${XSLTPROC} -o $@ ${top_srcdir}/doc/xsl/isc-manpage.xsl $<

bin/named/Makefile.am

@@ -107,3 +107,6 @@ if HAVE_JSON_C
 named_LDADD +=					\
 	$(JSON_C_LIBS)
 endif HAVE_JSON_C
+
+man8_MANS = named.8 lwresd.8
+man5_MANS = named.conf.5

bin/named/named.8

@@ -9,7 +9,7 @@
 '\" t
 .\"     Title: named
 .\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
+.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
 .\"      Date: 2014-02-19
 .\"    Manual: BIND9
 .\"    Source: ISC
@@ -38,7 +38,7 @@
 .SH "NAME"
 named \- Internet domain name server
 .SH "SYNOPSIS"
-.HP \w'\fBnamed\fR\ 'u
+.HP 6
 \fBnamed\fR [[\fB\-4\fR] | [\fB\-6\fR]] [\fB\-c\ \fR\fB\fIconfig\-file\fR\fR] [\fB\-d\ \fR\fB\fIdebug\-level\fR\fR] [\fB\-D\ \fR\fB\fIstring\fR\fR] [\fB\-E\ \fR\fB\fIengine\-name\fR\fR] [\fB\-f\fR] [\fB\-g\fR] [\fB\-L\ \fR\fB\fIlogfile\fR\fR] [\fB\-M\ \fR\fB\fIoption\fR\fR] [\fB\-m\ \fR\fB\fIflag\fR\fR] [\fB\-n\ \fR\fB\fI#cpus\fR\fR] [\fB\-p\ \fR\fB\fIport\fR\fR] [\fB\-s\fR] [\fB\-S\ \fR\fB\fI#max\-socks\fR\fR] [\fB\-t\ \fR\fB\fIdirectory\fR\fR] [\fB\-U\ \fR\fB\fI#listeners\fR\fR] [\fB\-u\ \fR\fB\fIuser\fR\fR] [\fB\-v\fR] [\fB\-V\fR] [\fB\-X\ \fR\fB\fIlock\-file\fR\fR] [\fB\-x\ \fR\fB\fIcache\-file\fR\fR]
 .SH "DESCRIPTION"
 .PP
@@ -164,20 +164,9 @@ Listen for queries on port
 Write memory usage statistics to
 stdout
 on exit\&.
-.if n \{\
+.RS
-.sp
+.B "Note:"
-.\}
-.RS 4
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBNote\fR
-.ps -1
-.br
 This option is mainly of interest to BIND 9 developers and may be removed or changed in a future release\&.
-.sp .5v
 .RE
 .RE
 .PP
@@ -188,22 +177,11 @@ Allow
 to use up to
 \fI#max\-socks\fR
 sockets\&. The default value is 21000 on systems built with default configuration options, and 4096 on systems built with "configure \-\-with\-tuning=small"\&.
-.if n \{\
+.RS
-.sp
+.B "Warning:"
-.\}
-.RS 4
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBWarning\fR
-.ps -1
-.br
 This option should be unnecessary for the vast majority of users\&. The use of this option could even be harmful because the specified value may exceed the limitation of the underlying system API\&. It is therefore set only when the default configuration causes exhaustion of file descriptors and the operational environment is known to support the specified number of sockets\&. Note also that the actual maximum number is normally a little fewer than the specified value because
 \fBnamed\fR
 reserves some file descriptors for its internal use\&.
-.sp .5v
 .RE
 .RE
 .PP
@@ -212,24 +190,13 @@ reserves some file descriptors for its internal use\&.
 Chroot to
 \fIdirectory\fR
 after processing the command line arguments, but before reading the configuration file\&.
-.if n \{\
+.RS
-.sp
+.B "Warning:"
-.\}
-.RS 4
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBWarning\fR
-.ps -1
-.br
 This option should be used in conjunction with the
 \fB\-u\fR
 option, as chrooting a process running as root doesn\*(Aqt enhance security on most systems; the way
 \fBchroot(2)\fR
 is defined allows a process with root privileges to escape a chroot jail\&.
-.sp .5v
 .RE
 .RE
 .PP
@@ -251,18 +218,8 @@ may be increased as high as that value, but no higher\&. On Windows, the number
 Setuid to
 \fIuser\fR
 after completing privileged operations, such as creating sockets that listen on privileged ports\&.
-.if n \{\
+.RS
-.sp
+.B "Note:"
-.\}
-.RS 4
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBNote\fR
-.ps -1
-.br
 On Linux,
 \fBnamed\fR
 uses the kernel\*(Aqs capability mechanism to drop all root privileges except the ability to
@@ -273,7 +230,6 @@ option only works when
 \fBnamed\fR
 is run on kernel 2\&.2\&.18 or later, or kernel 2\&.3\&.99\-pre3 or later, since previous kernels did not allow privileges to be retained after
 \fBsetuid(2)\fR\&.
-.sp .5v
 .RE
 .RE
 .PP
@@ -303,20 +259,9 @@ none, the lock file check is disabled\&.
 Load data from
 \fIcache\-file\fR
 into the cache of the default view\&.
-.if n \{\
+.RS
-.sp
+.B "Warning:"
-.\}
-.RS 4
-.it 1 an-trap
-.nr an-no-space-flag 1
-.nr an-break-flag 1
-.br
-.ps +1
-\fBWarning\fR
-.ps -1
-.br
 This option must not be used\&. It is only of interest to BIND 9 developers and may be removed or changed in a future release\&.
-.sp .5v
 .RE
 .RE
 .SH "SIGNALS"

configure.ac

@@ -1597,6 +1597,46 @@ AC_CONFIG_FILES([bin/tests/system/stop.sh],
 AC_CONFIG_FILES([bin/tests/system/system-test-driver.sh],
 		[chmod +x bin/tests/system/system-test-driver.sh])
 
+# Documentation
+
+#
+# Look for Docbook-XSL stylesheets.  Location probably varies by system.
+# If it's not explicitly specified, guess where it might be found, based on
+# where SGML stuff lives on some systems (FreeBSD is the only one we're sure
+# of at the moment).
+#
+AC_MSG_CHECKING(for Docbook-XSL path)
+AC_ARG_WITH(docbook-xsl,
+            AS_HELP_STRING([--with-docbook-xsl[=PATH]],
+                           [specify path for Docbook-XSL stylesheets]),
+   docbook_path="$withval", docbook_path="auto")
+case "$docbook_path" in
+auto)
+        AC_MSG_RESULT(auto)
+        docbook_xsl_trees="/usr/pkg/share/xsl/docbook /usr/local/share/xsl/docbook-ns /usr/local/share/xsl/docbook /usr/share/xsl/docbook /usr/share/sgml/docbook/xsl-stylesheets /opt/local/share/xsl/docbook-xsl /opt/local/share/xsl/docbook-xsl-nons /usr/share/xml/docbook/stylesheet/docbook-xsl"
+        ;;
+*)
+        docbook_xsl_trees="$withval"
+        AC_MSG_RESULT($docbook_xsl_trees)
+        ;;
+esac
+
+#
+# Look for stylesheets we need.
+#
+
+AX_PATH_FILE(XSLT_DOCBOOK_STYLE_HTML, html/docbook.xsl, $docbook_xsl_trees)
+AX_PATH_FILE(XSLT_DOCBOOK_STYLE_XHTML, xhtml/docbook.xsl, $docbook_xsl_trees)
+AX_PATH_FILE(XSLT_DOCBOOK_STYLE_MAN, manpages/docbook.xsl, $docbook_xsl_trees)
+AX_PATH_FILE(XSLT_DOCBOOK_CHUNK_HTML, html/chunk.xsl, $docbook_xsl_trees)
+AX_PATH_FILE(XSLT_DOCBOOK_CHUNK_XHTML, xhtml/chunk.xsl, $docbook_xsl_trees)
+AX_PATH_FILE(XSLT_DOCBOOK_CHUNKTOC_HTML, html/chunktoc.xsl, $docbook_xsl_trees)
+AX_PATH_FILE(XSLT_DOCBOOK_CHUNKTOC_XHTML, xhtml/chunktoc.xsl, $docbook_xsl_trees)
+AX_PATH_FILE(XSLT_DOCBOOK_MAKETOC_HTML, html/maketoc.xsl, $docbook_xsl_trees)
+AX_PATH_FILE(XSLT_DOCBOOK_MAKETOC_XHTML, xhtml/maketoc.xsl, $docbook_xsl_trees)
+
+AC_CONFIG_FILES([doc/xsl/isc-manpage.xsl])
+
 # Misc
 
 AC_CONFIG_FILES([util/check-make-install])

m4/ax_path_file.m4

@@ -0,0 +1,33 @@
+#
+# Subroutine for searching for an ordinary file (e.g., a stylesheet)
+# in a number of directories:
+#
+#   AX_PATH_FILE(VARIABLE, FILENAME, DIRECTORIES)
+#
+# If the file FILENAME is found in one of the DIRECTORIES, the shell
+# variable VARIABLE is defined to its absolute pathname.  Otherwise,
+# it is set to FILENAME, with no directory prefix (that's not terribly
+# useful, but looks less confusing in substitutions than leaving it
+# empty).  The variable VARIABLE will be substituted into output files.
+#
+
+AC_DEFUN([AX_PATH_FILE], [
+$1=""
+AC_MSG_CHECKING(for $2)
+for d in $3
+do
+        f=$d/$2
+        if test -f $f
+        then
+                $1=$f
+                AC_MSG_RESULT($f)
+                break
+        fi
+done
+if test "X[$]$1" = "X"
+then
+        AC_MSG_RESULT("not found");
+        $1=$2
+fi
+AC_SUBST($1)
+])