doc/idzebra-config.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
   2  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
   3 [
   4      <!ENTITY % local SYSTEM "local.ent">
   5      %local;
   6      <!ENTITY % entities  SYSTEM "entities.ent">
   7      %entities;
   8      <!ENTITY % idcommon  SYSTEM "common/common.ent">
   9      %idcommon;
  10 ]>
  11 <refentry id="idzebra-config">
  12  <refentryinfo>
  13   <productname>zebra</productname>
  14   <productnumber>&version;</productnumber>
  15   <info><orgname>Index Data</orgname></info>
  16  </refentryinfo>
  17
  18  <refmeta>
  19   <refentrytitle>idzebra-config</refentrytitle>
  20   <manvolnum>1</manvolnum>
  21   <refmiscinfo class="manual">Commands</refmiscinfo>
  22  </refmeta>
  23
  24  <refnamediv>
  25   <refname>idzebra-config</refname>
  26   <refpurpose>Script to get information about idzebra</refpurpose>
  27  </refnamediv>
  28
  29  <refsynopsisdiv>
  30   <cmdsynopsis>
  31    <command>idzebra-config</command>
  32    <arg choice="opt"><option>--prefix[=<replaceable>DIR</replaceable>]</option></arg>
  33    <arg choice="opt"><option>--version</option></arg>
  34    <arg choice="opt"><option>--libs</option></arg>
  35    <arg choice="opt"><option>--lalibs</option></arg>
  36    <arg choice="opt"><option>--cflags</option></arg>
  37    <arg choice="opt"><option>--tab</option></arg>
  38    <arg choice="opt"><option>--modules</option></arg>
  39    <arg choice="opt" rep="repeat">libraries</arg>
  40   </cmdsynopsis>
  41  </refsynopsisdiv>
  42
  43  <refsect1><title>DESCRIPTION</title>
  44   <para>
  45    <command>idzebra-config</command> is a script that returns information
  46    that your own software should use to build software that uses idzebra.
  47   </para>
  48
  49   <para>
  50    The following libraries are supported:
  51   </para>
  52
  53   <para>
  54    None
  55   </para>
  56
  57  </refsect1>
  58
  59  <refsect1><title>OPTIONS</title>
  60
  61   <variablelist>
  62    <varlistentry>
  63     <term>--prefix[=<replaceable>DIR</replaceable>]</term>
  64     <listitem><para>
  65       Returns prefix of idzebra or assume a different one if DIR is
  66       specified.
  67      </para></listitem>
  68    </varlistentry>
  69
  70    <varlistentry>
  71     <term>--version</term>
  72     <listitem><para>
  73       Returns version of idzebra.
  74      </para></listitem>
  75    </varlistentry>
  76
  77    <varlistentry>
  78     <term>--libs</term>
  79     <listitem><para>
  80       Library specification be used when linking with idzebra.
  81      </para></listitem>
  82    </varlistentry>
  83
  84    <varlistentry>
  85     <term>--lalibs</term>
  86     <listitem><para>
  87       Return library specification.
  88      </para></listitem>
  89    </varlistentry>
  90
  91    <varlistentry>
  92     <term>--cflags</term>
  93     <listitem><para>
  94       Return C Compiler flags.
  95      </para></listitem>
  96    </varlistentry>
  97
  98    <varlistentry>
  99     <term>--tab</term>
 100     <listitem><para>
 101       Return directory of idzebra tables.
 102      </para></listitem>
 103    </varlistentry>
 104
 105    <varlistentry>
 106     <term>--modules</term>
 107     <listitem><para>
 108       Return directory for &zebra; modules.
 109      </para></listitem>
 110    </varlistentry>
 111
 112   </variablelist>
 113  </refsect1>
 114
 115  <refsect1><title>FILES</title>
 116   <para>
 117    <filename>&prefix;/bin/idzebra-config-2.0</filename>
 118   </para>
 119   <para>
 120    <filename>&prefix;/lib/libidzebra*2.0.a</filename>
 121   </para>
 122   <para>
 123    <filename>&prefix;/include/idzebra-2.0/idzebra/*.h</filename>
 124   </para>
 125  </refsect1>
 126
 127 </refentry>
 128
 129 <!-- Keep this comment at the end of the file
 130 Local variables:
 131 mode: sgml
 132 sgml-omittag:t
 133 sgml-shorttag:t
 134 sgml-minimize-attributes:nil
 135 sgml-always-quote-attributes:t
 136 sgml-indent-step:1
 137 sgml-indent-data:t
 138 sgml-parent-document:nil
 139 sgml-local-catalogs: nil
 140 sgml-namecase-general:t
 141 End:
 142 -->