added man pace for yazpp-config.8
authorMarc Cromme <marc@indexdata.dk>
Mon, 24 Apr 2006 08:55:28 +0000 (08:55 +0000)
committerMarc Cromme <marc@indexdata.dk>
Mon, 24 Apr 2006 08:55:28 +0000 (08:55 +0000)
doc/Makefile.am
doc/yazpp-config-man.xml [new file with mode: 0644]

index b8a3a2e..1ff6e7b 100644 (file)
@@ -1,4 +1,4 @@
-## $Id: Makefile.am,v 1.18 2006-04-20 11:36:40 adam Exp $
+## $Id: Makefile.am,v 1.19 2006-04-24 08:55:28 marc Exp $
 docdir=$(datadir)/doc/@PACKAGE@
 
 SUBDIRS = common
@@ -10,9 +10,13 @@ XMLFILES = \
  api.xml \
  license.xml \
  yazpp.xml.in
+
 TOP=yazpp.xml
-MANFILES=
+
+MANFILES = yazpp-config.8
+
+REFFILES = yazpp-config-man.xml
+
 HTMLFILES = \
  api.html \
  implementations.html \
@@ -32,7 +36,7 @@ doc_DATA = $(HTMLFILES) yazpp.pdf
 
 man_MANS = $(MANFILES)
 
-EXTRA_DIST = $(XMLFILES) $(doc_DATA) $(man_MANS)
+EXTRA_DIST = $(XMLFILES) $(doc_DATA) $(man_MANS)  $(REFFILES) 
 
 $(HTMLFILES): $(XMLFILES)
        jade -E14 -D $(srcdir) -d common/html.dsl -t sgml $(srcdir)/common/xml.dcl $(TOP)
@@ -47,6 +51,11 @@ yazpp.pdf: $(XMLFILES)
 index.tkl: $(XMLFILES) common/tkl.xsl
        xsltproc common/tkl.xsl $(TOP)
 
+
+yazpp-config.8: yazpp-config-man.xml
+       docbook2man $(srcdir)/yazpp-config-man.xml
+
+
 clean-data-hook:
        rm -f [0-9]* *.bak
 
diff --git a/doc/yazpp-config-man.xml b/doc/yazpp-config-man.xml
new file mode 100644 (file)
index 0000000..fb2c1c0
--- /dev/null
@@ -0,0 +1,131 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!-- $Id: yazpp-config-man.xml,v 1.1 2006-04-24 08:55:28 marc Exp $ -->
+<refentry id="yazpp-config">
+ <refmeta>
+  <refentrytitle>yazpp-config</refentrytitle>
+  <manvolnum>8</manvolnum>
+ </refmeta>
+ <refnamediv>
+  <refname>yazpp-config</refname>
+  <refpurpose>Script to get information about YAZ.</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+  <cmdsynopsis>
+   <command>yazpp-config</command>
+   <arg choice="opt"><option>--prefix[=<replaceable>DIR</replaceable>]</option></arg>
+   <arg choice="opt"><option>--version</option></arg>
+   <arg choice="opt"><option>--libs</option></arg>
+   <arg choice="opt"><option>--lalibs</option></arg>
+   <arg choice="opt"><option>--cflags</option></arg>
+   <arg choice="opt"><option>--comp</option></arg>
+   <arg choice="opt" rep="repeat">libraries</arg>
+  </cmdsynopsis>
+ </refsynopsisdiv>
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   <command>yazpp-config</command> is a script that returns information
+   that your own software should use to build software that uses YAZ.
+  </para>
+
+  <para>
+   The following libraries are supported:
+  </para>
+
+  <variablelist>
+   <varlistentry>
+    <term>threads</term>
+    <listitem><para>
+      Use the threaded version of YAZ.
+     </para></listitem>
+   </varlistentry>
+  </variablelist>
+  
+ </refsect1>
+ <refsect1><title>OPTIONS</title>
+  
+  <variablelist>
+   <varlistentry>
+    <term>--prefix[=<replaceable>DIR</replaceable>]</term>
+    <listitem><para>
+      Returns prefix of YAZ or assume a different one if DIR is
+      specified.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>--version</term>
+    <listitem><para>
+      Returns version of YAZ.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>--libs</term>
+    <listitem><para>
+      Library specification be used when using YAZ.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>--lalibs</term>
+    <listitem><para>
+      Return library specification.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>--cflags</term>
+    <listitem><para>
+      Return C Compiler flags.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>--comp</term>
+    <listitem><para>
+      Returns full path to YAZ' ASN.1 compiler: yaz-asncomp.
+     </para></listitem>
+   </varlistentry>
+
+  </variablelist>
+ </refsect1>
+ <refsect1><title>FILES</title>
+  <para>
+   <filename><replaceable>prefix</replaceable>/bin/yazpp-config</filename>
+  </para>
+  <para>
+   <filename><replaceable>prefix</replaceable>/lib/libyazpp*.a</filename>
+  </para>
+  <para>
+   <filename><replaceable>prefix</replaceable>/include/yazpp/*.h</filename>
+  </para>
+  </refsect1>
+ <refsect1><title>SEE ALSO</title>
+  <para>
+   yaz(7)
+  </para>
+  <para>
+   Section "How to make apps using YAZ on UNIX" in the YAZ manual.
+  </para>
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-local-catalogs: nil
+sgml-namecase-general:t
+End:
+-->