doc/yaz-config-man.xml

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