doc/yazpp-config-man.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 <refentry id="yazpp-config">
   5
   6  <refentryinfo>
   7   <productname>yazpp</productname>
   8   <info><orgname>Index Data</orgname></info>
   9  </refentryinfo>
  10
  11  <refmeta>
  12   <refentrytitle>yazpp-config</refentrytitle>
  13   <manvolnum>1</manvolnum>
  14   <refmiscinfo class="manual">Commands</refmiscinfo>
  15  </refmeta>
  16
  17  <refnamediv>
  18   <refname>yazpp-config</refname>
  19   <refpurpose>Script to get information about YAZ++.</refpurpose>
  20  </refnamediv>
  21
  22  <refsynopsisdiv>
  23   <cmdsynopsis>
  24    <command>yazpp-config</command>
  25    <arg choice="opt"><option>--prefix[=<replaceable>DIR</replaceable>]</option></arg>
  26    <arg choice="opt"><option>--version</option></arg>
  27    <arg choice="opt"><option>--libs</option></arg>
  28    <arg choice="opt"><option>--lalibs</option></arg>
  29    <arg choice="opt"><option>--cflags</option></arg>
  30    <arg choice="opt" rep="repeat">libraries</arg>
  31   </cmdsynopsis>
  32  </refsynopsisdiv>
  33
  34  <refsect1><title>DESCRIPTION</title>
  35   <para>
  36    <command>yazpp-config</command> is a script that returns information
  37    that your own software should use to build software that uses YAZ++.
  38   </para>
  39
  40   <para>
  41    The following libraries are supported:
  42   </para>
  43
  44   <variablelist>
  45    <varlistentry>
  46     <term>zoom</term>
  47     <listitem><para>
  48       Report the zoompp library rather than yazpp.
  49      </para></listitem>
  50    </varlistentry>
  51   </variablelist>
  52  </refsect1>
  53
  54  <refsect1><title>OPTIONS</title>
  55
  56   <variablelist>
  57    <varlistentry>
  58     <term>--prefix[=<replaceable>DIR</replaceable>]</term>
  59     <listitem><para>
  60       Returns prefix of YAZ++ or assume a different one if DIR is
  61       specified.
  62      </para></listitem>
  63    </varlistentry>
  64
  65    <varlistentry>
  66     <term>--version</term>
  67     <listitem><para>
  68       Returns version of YAZ++.
  69      </para></listitem>
  70    </varlistentry>
  71
  72    <varlistentry>
  73     <term>--libs</term>
  74     <listitem><para>
  75       Library specification be used when using YAZ++.
  76      </para></listitem>
  77    </varlistentry>
  78
  79    <varlistentry>
  80     <term>--lalibs</term>
  81     <listitem><para>
  82       Return library specification.
  83      </para></listitem>
  84    </varlistentry>
  85
  86    <varlistentry>
  87     <term>--cflags</term>
  88     <listitem><para>
  89       Return C++ Compiler flags.
  90      </para></listitem>
  91    </varlistentry>
  92
  93
  94    <!--<varlistentry>
  95     <term>- -comp</term>
  96     <listitem><para>
  97       Returns full path to YAZ' ASN.1 compiler: yaz-asncomp.
  98      </para></listitem>
  99    </varlistentry>-->
 100
 101   </variablelist>
 102  </refsect1>
 103
 104  <refsect1><title>FILES</title>
 105   <para>
 106    <filename><replaceable>prefix</replaceable>/bin/yazpp-config</filename>
 107   </para>
 108   <para>
 109    <filename><replaceable>prefix</replaceable>/lib/libyazpp*.a</filename>
 110   </para>
 111   <para>
 112    <filename><replaceable>prefix</replaceable>/include/yazpp/*.h</filename>
 113   </para>
 114   </refsect1>
 115  <refsect1><title>SEE ALSO</title>
 116   <para>
 117    yaz(7)
 118   </para>
 119   <para>
 120    Section "How to make apps using YAZ on UNIX" in the YAZ manual.
 121   </para>
 122  </refsect1>
 123 </refentry>
 124
 125 <!-- Keep this comment at the end of the file
 126 Local variables:
 127 mode: sgml
 128 sgml-omittag:t
 129 sgml-shorttag:t
 130 sgml-minimize-attributes:nil
 131 sgml-always-quote-attributes:t
 132 sgml-indent-step:1
 133 sgml-indent-data:t
 134 sgml-parent-document:nil
 135 sgml-local-catalogs: nil
 136 sgml-namecase-general:t
 137 End:
 138 -->