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"><option>-V</option></arg>
  37    <arg choice="opt" rep="repeat">libraries</arg>
  38   </cmdsynopsis>
  39  </refsynopsisdiv>
  40
  41  <refsect1><title>DESCRIPTION</title>
  42   <para>
  43    <command>yaz-config</command> is a script that returns information
  44    that your own software should use to build software that uses YAZ.
  45   </para>
  46
  47   <para>
  48    The following libraries are supported:
  49   </para>
  50
  51   <variablelist>
  52    <varlistentry>
  53     <term>threads</term>
  54     <listitem><para>
  55       Use the threaded version of YAZ.
  56      </para></listitem>
  57    </varlistentry>
  58   </variablelist>
  59
  60  </refsect1>
  61
  62  <refsect1><title>OPTIONS</title>
  63
  64   <variablelist>
  65    <varlistentry>
  66     <term>--prefix[=<replaceable>DIR</replaceable>]</term>
  67     <listitem><para>
  68       Returns prefix of YAZ or assume a different one if DIR is
  69       specified.
  70      </para></listitem>
  71    </varlistentry>
  72
  73    <varlistentry>
  74     <term>--version</term>
  75     <listitem><para>
  76       Returns version of YAZ.
  77      </para></listitem>
  78    </varlistentry>
  79
  80    <varlistentry>
  81     <term>--libs</term>
  82     <listitem><para>
  83       Library specification be used when using YAZ.
  84      </para></listitem>
  85    </varlistentry>
  86
  87    <varlistentry>
  88     <term>--lalibs</term>
  89     <listitem><para>
  90       Return library specification.
  91      </para></listitem>
  92    </varlistentry>
  93
  94    <varlistentry>
  95     <term>--cflags</term>
  96     <listitem><para>
  97       Return C Compiler flags.
  98      </para></listitem>
  99    </varlistentry>
 100
 101    <varlistentry>
 102     <term>--comp</term>
 103     <listitem><para>
 104       Returns full path to YAZ' ASN.1 compiler: yaz-asncomp.
 105      </para></listitem>
 106    </varlistentry>
 107
 108    <varlistentry>
 109     <term>-V</term>
 110     <listitem><para>
 111       veturns YAZ SHA1 ID (from Git) and version.
 112      </para></listitem>
 113    </varlistentry>
 114
 115   </variablelist>
 116  </refsect1>
 117
 118  <refsect1><title>FILES</title>
 119   <para>
 120    <filename>&prefix;/bin/yaz-config</filename>
 121   </para>
 122   <para>
 123    <filename>&prefix;/lib/libyaz*.a</filename>
 124   </para>
 125   <para>
 126    <filename>&prefix;/include/yaz/*.h</filename>
 127   </para>
 128   </refsect1>
 129  <refsect1><title>SEE ALSO</title>
 130   <para>
 131    yaz(7)
 132   </para>
 133   <para>
 134    Section "How to make apps using YAZ on UNIX" in the YAZ manual.
 135   </para>
 136  </refsect1>
 137 </refentry>
 138
 139 <!-- Keep this comment at the end of the file
 140 Local variables:
 141 mode: sgml
 142 sgml-omittag:t
 143 sgml-shorttag:t
 144 sgml-minimize-attributes:nil
 145 sgml-always-quote-attributes:t
 146 sgml-indent-step:1
 147 sgml-indent-data:t
 148 sgml-parent-document:nil
 149 sgml-local-catalogs: nil
 150 sgml-namecase-general:t
 151 End:
 152 -->