2661. [doc] Add isc-config.sh(1) man page. [RT #16378]

This commit is for docbook and Makefile.in. I assume the
doc generation will create and add the generated html and roff files.
I purposely don't include in ARM generation since it doesn't
include "development" functions.

diff --git a/CHANGES b/CHANGES
index 9552ce26c4c9b27e034080b35ba13129f00f8de9..334db4c367e808d2a9f117c788ac0c09ade26b99 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -1,3 +1,5 @@
+2661.  [doc]           Add isc-config.sh(1) man page. [RT #16378]
+
 2660.  [bug]           Add #include <config.h> to iptable.c. [RT #18258]
 
 2559.  [bug]           dnssec-dsfromkey could compute bad DS records when

diff --git a/Makefile.in b/Makefile.in
index cfdfb0019c279b34b2e6d2948da925dba93ea4db..d7cbd364b396fcc1bf955e1df98ce2f86636e00e 100644 (file)
--- a/Makefile.in
+++ b/Makefile.in
@@ -13,7 +13,7 @@
 # OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 # PERFORMANCE OF THIS SOFTWARE.
 
-# $Id: Makefile.in,v 1.52 2008/09/25 04:02:38 tbox Exp $
+# $Id: Makefile.in,v 1.53 2009/02/18 23:21:50 jreed Exp $
 
 srcdir =       @srcdir@
 VPATH =                @srcdir@
@@ -24,6 +24,12 @@ top_srcdir = @top_srcdir@
 SUBDIRS =      make lib bin doc
 TARGETS =
 
+MANPAGES =     isc-config.sh.1
+ 
+HTMLPAGES =    isc-config.sh.html
+ 
+MANOBJS =      ${MANPAGES} ${HTMLPAGES}
+
 @BIND9_MAKE_RULES@
 
 distclean::
@@ -36,12 +42,19 @@ distclean::
 maintainer-clean::
        rm -f configure
 
+docclean manclean maintainer-clean::
+       rm -f ${MANOBJS}
+
+doc man:: ${MANOBJS}
+
 installdirs:
        $(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${bindir} \
        ${DESTDIR}${localstatedir}/run ${DESTDIR}${sysconfdir}
+       $(SHELL) ${top_srcdir}/mkinstalldirs ${DESTDIR}${mandir}/man1
 
 install:: isc-config.sh installdirs
        ${INSTALL_SCRIPT} isc-config.sh ${DESTDIR}${bindir}
+       ${INSTALL_DATA} ${srcdir}/isc-config.sh.1 ${DESTDIR}${mandir}/man1
 
 tags:
        rm -f TAGS

diff --git a/isc-config.sh.docbook b/isc-config.sh.docbook
new file mode 100644 (file)
index 0000000..02db4ae
--- /dev/null
+++ b/isc-config.sh.docbook
@@ -0,0 +1,160 @@
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+               "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"
+              [<!ENTITY mdash "&#8212;">]>
+<!--
+ - Copyright (C) 2008  Internet Systems Consortium, Inc. ("ISC")
+ -
+ - Permission to use, copy, modify, and/or distribute this software for any
+ - purpose with or without fee is hereby granted, provided that the above
+ - copyright notice and this permission notice appear in all copies.
+ -
+ - THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH
+ - REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+ - AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT,
+ - INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+ - LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+ - OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+ - PERFORMANCE OF THIS SOFTWARE.
+-->
+
+<!-- $Id: isc-config.sh.docbook,v 1.1 2009/02/18 23:21:50 jreed Exp $ -->
+<refentry id="man.isc-config.sh">
+  <refentryinfo>
+    <date>December 19, 2008</date>
+  </refentryinfo>
+
+  <refmeta>
+    <refentrytitle><application>isc-config.sh</application></refentrytitle>
+    <manvolnum>1</manvolnum>
+    <refmiscinfo>BIND9</refmiscinfo>
+  </refmeta>
+
+  <docinfo>
+    <copyright>
+      <year>2008</year>
+      <holder>Internet Systems Consortium, Inc. ("ISC")</holder>
+    </copyright>
+  </docinfo>
+
+  <refnamediv>
+    <refname><application>isc-config.sh</application></refname>
+    <refpurpose>Get information about the installed version of ISC BIND</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+      <command>isc-config.sh</command>
+      <arg><option>--cflags</option></arg>
+      <arg><option>--exec-prefix</option></arg>
+      <arg><option>--libs</option></arg>
+      <arg><option>--prefix</option></arg>
+      <arg><option>--version</option></arg>
+      <arg choice="opt" rep="repeat">libraries</arg>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsect1>
+    <title>DESCRIPTION</title>
+    <para><command>isc-config.sh</command>
+       prints information related to the installed version of ISC BIND,
+       such as the compiler and linker flags required to compile
+       and link programs that use ISC BIND libraries.
+    </para>
+    <para>
+       The optional libraries are used to report specific details
+       for compiling and linking for the listed libraries.
+       The allowed choices are:
+        <option>isc</option>,
+        <option>isccc</option>,
+        <option>isccfg</option>,
+        <option>dns</option>,
+        <option>lwres</option>, and
+        <option>bind9</option>.
+       Multiple libraries may be listed on the command line.
+       (Some libraries require other libraries, so are implied.)
+    </para>
+
+  </refsect1>
+
+  <refsect1>
+    <title>OPTIONS</title>
+
+    <variablelist>
+
+      <varlistentry>
+        <term>--cflags</term>
+        <listitem>
+          <para>
+            Prints the compiler command line options required to
+            compile files that use ISC BIND.
+            Use the <option>libraries</option> command line argument(s)
+            to print additional specific flags to pass to the C compiler.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>--exec-prefix</term>
+        <listitem>
+          <para>
+            Prints the directory prefix used in the ISC BIND installation
+            for architecture dependent files to standard output.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>--libs</term>
+        <listitem>
+          <para>
+            Prints the linker command line options used to
+            link with the ISC BIND libraries.
+            Use the <option>libraries</option> command line argument(s)
+            to print additional specific flags.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>--prefix</term>
+        <listitem>
+          <para>
+            Prints the directory prefix used in the ISC BIND installation
+            for architecture independent files to standard output.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>--version</term>
+        <listitem>
+          <para>
+            Prints the version of the installed ISC BIND suite.
+          </para>
+        </listitem>
+      </varlistentry>
+
+    </variablelist>
+
+  </refsect1>
+
+  <refsect1>
+    <title>RETURN VALUES</title>
+    <para><command>isc-config.sh</command>
+      returns an exit status of 1 if
+      invoked with invalid arguments or no arguments at all.
+      It returns 0 if information was successfully printed.
+    </para>
+  </refsect1>
+
+  <refsect1>
+    <title>AUTHOR</title>
+    <para><corpauthor>Internet Systems Consortium</corpauthor>
+    </para>
+  </refsect1>
+
+</refentry><!--
+ - Local variables:
+ - mode: sgml
+ - End:
+-->