]> git.ipfire.org Git - thirdparty/bind9.git/commitdiff
Add generated docs for new isc-config.sh manpage.
authorJeremy Reed <jreed@isc.org>
Fri, 20 Feb 2009 22:24:49 +0000 (22:24 +0000)
committerJeremy Reed <jreed@isc.org>
Fri, 20 Feb 2009 22:24:49 +0000 (22:24 +0000)
Built on docs.

isc-config.sh.1 [new file with mode: 0644]
isc-config.sh.html [new file with mode: 0644]

diff --git a/isc-config.sh.1 b/isc-config.sh.1
new file mode 100644 (file)
index 0000000..b3e4557
--- /dev/null
@@ -0,0 +1,87 @@
+.\" Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
+.\" 
+.\" Permission to use, copy, modify, and 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.1,v 1.1 2009/02/20 22:24:49 jreed Exp $
+.\"
+.hy 0
+.ad l
+.\"     Title: isc\-config.sh
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.71.1 <http://docbook.sf.net/>
+.\"      Date: December 19, 2008
+.\"    Manual: BIND9
+.\"    Source: BIND9
+.\"
+.TH "ISC\-CONFIG.SH" "1" "December 19, 2008" "BIND9" "BIND9"
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+isc\-config.sh \- Get information about the installed version of ISC BIND
+.SH "SYNOPSIS"
+.HP 14
+\fBisc\-config.sh\fR [\fB\-\-cflags\fR] [\fB\-\-exec\-prefix\fR] [\fB\-\-libs\fR] [\fB\-\-prefix\fR] [\fB\-\-version\fR] [libraries...]
+.SH "DESCRIPTION"
+.PP
+\fBisc\-config.sh\fR
+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.
+.PP
+The optional libraries are used to report specific details for compiling and linking for the listed libraries. The allowed choices are:
+\fBisc\fR,
+\fBisccc\fR,
+\fBisccfg\fR,
+\fBdns\fR,
+\fBlwres\fR, and
+\fBbind9\fR. Multiple libraries may be listed on the command line. (Some libraries require other libraries, so are implied.)
+.SH "OPTIONS"
+.PP
+\-\-cflags
+.RS 4
+Prints the compiler command line options required to compile files that use ISC BIND. Use the
+\fBlibraries\fR
+command line argument(s) to print additional specific flags to pass to the C compiler.
+.RE
+.PP
+\-\-exec\-prefix
+.RS 4
+Prints the directory prefix used in the ISC BIND installation for architecture dependent files to standard output.
+.RE
+.PP
+\-\-libs
+.RS 4
+Prints the linker command line options used to link with the ISC BIND libraries. Use the
+\fBlibraries\fR
+command line argument(s) to print additional specific flags.
+.RE
+.PP
+\-\-prefix
+.RS 4
+Prints the directory prefix used in the ISC BIND installation for architecture independent files to standard output.
+.RE
+.PP
+\-\-version
+.RS 4
+Prints the version of the installed ISC BIND suite.
+.RE
+.SH "RETURN VALUES"
+.PP
+\fBisc\-config.sh\fR
+returns an exit status of 1 if invoked with invalid arguments or no arguments at all. It returns 0 if information was successfully printed.
+.SH "AUTHOR"
+.PP
+Internet Systems Consortium
+.SH "COPYRIGHT"
+Copyright \(co 2009 Internet Systems Consortium, Inc. ("ISC")
+.br
diff --git a/isc-config.sh.html b/isc-config.sh.html
new file mode 100644 (file)
index 0000000..dc95f41
--- /dev/null
@@ -0,0 +1,101 @@
+<!--
+ - Copyright (C) 2009 Internet Systems Consortium, Inc. ("ISC")
+ - 
+ - Permission to use, copy, modify, and 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.html,v 1.1 2009/02/20 22:24:49 jreed Exp $ -->
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>isc-config.sh</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.71.1">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
+<a name="man.isc-config.sh"></a><div class="titlepage"></div>
+<div class="refnamediv">
+<h2>Name</h2>
+<p><span class="application">isc-config.sh</span> &#8212; Get information about the installed version of ISC BIND</p>
+</div>
+<div class="refsynopsisdiv">
+<h2>Synopsis</h2>
+<div class="cmdsynopsis"><p><code class="command">isc-config.sh</code>  [<code class="option">--cflags</code>] [<code class="option">--exec-prefix</code>] [<code class="option">--libs</code>] [<code class="option">--prefix</code>] [<code class="option">--version</code>] [libraries...]</p></div>
+</div>
+<div class="refsect1" lang="en">
+<a name="id2543361"></a><h2>DESCRIPTION</h2>
+<p><span><strong class="command">isc-config.sh</strong></span>
+       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.
+    </p>
+<p>
+       The optional libraries are used to report specific details
+       for compiling and linking for the listed libraries.
+       The allowed choices are:
+        <code class="option">isc</code>,
+        <code class="option">isccc</code>,
+        <code class="option">isccfg</code>,
+        <code class="option">dns</code>,
+        <code class="option">lwres</code>, and
+        <code class="option">bind9</code>.
+       Multiple libraries may be listed on the command line.
+       (Some libraries require other libraries, so are implied.)
+    </p>
+</div>
+<div class="refsect1" lang="en">
+<a name="id2543395"></a><h2>OPTIONS</h2>
+<div class="variablelist"><dl>
+<dt><span class="term">--cflags</span></dt>
+<dd><p>
+            Prints the compiler command line options required to
+            compile files that use ISC BIND.
+            Use the <code class="option">libraries</code> command line argument(s)
+            to print additional specific flags to pass to the C compiler.
+          </p></dd>
+<dt><span class="term">--exec-prefix</span></dt>
+<dd><p>
+            Prints the directory prefix used in the ISC BIND installation
+            for architecture dependent files to standard output.
+          </p></dd>
+<dt><span class="term">--libs</span></dt>
+<dd><p>
+            Prints the linker command line options used to
+            link with the ISC BIND libraries.
+            Use the <code class="option">libraries</code> command line argument(s)
+            to print additional specific flags.
+          </p></dd>
+<dt><span class="term">--prefix</span></dt>
+<dd><p>
+            Prints the directory prefix used in the ISC BIND installation
+            for architecture independent files to standard output.
+          </p></dd>
+<dt><span class="term">--version</span></dt>
+<dd><p>
+            Prints the version of the installed ISC BIND suite.
+          </p></dd>
+</dl></div>
+</div>
+<div class="refsect1" lang="en">
+<a name="id2543475"></a><h2>RETURN VALUES</h2>
+<p><span><strong class="command">isc-config.sh</strong></span>
+      returns an exit status of 1 if
+      invoked with invalid arguments or no arguments at all.
+      It returns 0 if information was successfully printed.
+    </p>
+</div>
+<div class="refsect1" lang="en">
+<a name="id2543486"></a><h2>AUTHOR</h2>
+<p><span class="corpauthor">Internet Systems Consortium</span>
+    </p>
+</div>
+</div></body>
+</html>