Put man pages in reference section of main documentation . Avoid

[idzebra-moved-to-github.git] / doc / idzebra-config.xml

diff --git a/doc/idzebra-config.xml b/doc/idzebra-config.xml
new file mode 100644 (file)
index 0000000..efb9e78
--- /dev/null
+++ b/doc/idzebra-config.xml
@@ -0,0 +1,141 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd"
+[
+     <!ENTITY % local SYSTEM "local.ent">
+     %local;
+     <!ENTITY % entities  SYSTEM "entities.ent">
+     %entities;
+     <!ENTITY % common  SYSTEM "common/common.ent">
+     %common;
+]>
+<!-- $Id: idzebra-config.xml,v 1.1 2006-09-05 12:01:31 adam Exp $ -->
+<refentry id="idzebra-config">
+ <refentryinfo>
+  <productname>ZEBRA</productname>
+  <productnumber>&version;</productnumber>
+ </refentryinfo>
+ 
+ <refmeta>
+  <refentrytitle>idzebra-config</refentrytitle>
+  <manvolnum>1</manvolnum>
+ </refmeta>
+ 
+ <refnamediv>
+  <refname>idzebra-config</refname>
+  <refpurpose>Script to get information about idzebra</refpurpose>
+ </refnamediv>
+ 
+ <refsynopsisdiv>
+  <cmdsynopsis>
+   <command>idzebra-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>--tab</option></arg>
+   <arg choice="opt"><option>--modules</option></arg>
+   <arg choice="opt" rep="repeat">libraries</arg>
+  </cmdsynopsis>
+ </refsynopsisdiv>
+ 
+ <refsect1><title>DESCRIPTION</title>
+  <para>
+   <command>idzebra-config</command> is a script that returns information
+   that your own software should use to build software that uses idzebra.
+  </para>
+
+  <para>
+   The following libraries are supported:
+  </para>
+
+  <para>
+   None
+  </para>
+  
+ </refsect1>
+ 
+ <refsect1><title>OPTIONS</title>
+  
+  <variablelist>
+   <varlistentry>
+    <term>--prefix[=<replaceable>DIR</replaceable>]</term>
+    <listitem><para>
+      Returns prefix of idzebra or assume a different one if DIR is
+      specified.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>--version</term>
+    <listitem><para>
+      Returns version of idzebra.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>--libs</term>
+    <listitem><para>
+      Library specification be used when linking with idzebra.
+     </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>--tab</term>
+    <listitem><para>
+      Return directory of idzebra tables.
+     </para></listitem>
+   </varlistentry>
+
+   <varlistentry>
+    <term>--modules</term>
+    <listitem><para>
+      Return directory for Zebra modules.
+     </para></listitem>
+   </varlistentry>
+
+  </variablelist>
+ </refsect1>
+ 
+ <refsect1><title>FILES</title>
+  <para>
+   <filename>&prefix;/bin/idzebra-config-2.0</filename>
+  </para>
+  <para>
+   <filename>&prefix;/lib/libidzebra*2.0.a</filename>
+  </para>
+  <para>
+   <filename>&prefix;/include/idzebra-2.0/idzebra/*.h</filename>
+  </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:
+-->