doc/yaz-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      <!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   <info><orgname>Index Data</orgname></info>
  16  </refentryinfo>
  17
  18  <refmeta>
  19   <refentrytitle>yaz-config</refentrytitle>
  20   <manvolnum>1</manvolnum>
  21   <refmiscinfo class="manual">Commands</refmiscinfo>
  22  </refmeta>
  23
  24  <refnamediv>
  25   <refname>yaz-config</refname>
  26   <refpurpose>Script to get information about YAZ.</refpurpose>
  27  </refnamediv>
  28
  29  <refsynopsisdiv>
  30   <cmdsynopsis>
  31    <command>yaz-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>--include</option></arg>
  38    <arg choice="opt"><option>--comp</option></arg>
  39    <arg choice="opt"><option>-V</option></arg>
  40    <arg choice="opt" rep="repeat">libraries</arg>
  41   </cmdsynopsis>
  42  </refsynopsisdiv>
  43
  44  <refsect1><title>DESCRIPTION</title>
  45   <para>
  46    <command>yaz-config</command> is a script that returns information
  47    that your own software should use to build software that uses YAZ.
  48   </para>
  49
  50   <para>
  51    The following libraries are supported:
  52   </para>
  53
  54   <variablelist>
  55    <varlistentry>
  56     <term>threads</term>
  57     <listitem><para>
  58       Use the threaded version of YAZ.
  59      </para></listitem>
  60    </varlistentry>
  61   </variablelist>
  62
  63  </refsect1>
  64
  65  <refsect1><title>OPTIONS</title>
  66
  67   <variablelist>
  68    <varlistentry>
  69     <term>--prefix[=<replaceable>DIR</replaceable>]</term>
  70     <listitem><para>
  71       Returns prefix of YAZ or assume a different one if DIR is
  72       specified.
  73      </para></listitem>
  74    </varlistentry>
  75
  76    <varlistentry>
  77     <term>--version</term>
  78     <listitem><para>
  79       Returns version of YAZ.
  80      </para></listitem>
  81    </varlistentry>
  82
  83    <varlistentry>
  84     <term>--libs</term>
  85     <listitem><para>
  86       Library specification be used when using YAZ.
  87      </para></listitem>
  88    </varlistentry>
  89
  90    <varlistentry>
  91     <term>--lalibs</term>
  92     <listitem><para>
  93       Return library specification.
  94      </para></listitem>
  95    </varlistentry>
  96
  97    <varlistentry>
  98     <term>--cflags</term>
  99     <listitem><para>
 100       Return C Compiler flags.
 101      </para></listitem>
 102    </varlistentry>
 103
 104    <varlistentry>
 105     <term>--include</term>
 106     <listitem><para>
 107       Return C compiler includes for YAZ header files (-Ipath).
 108      </para></listitem>
 109    </varlistentry>
 110
 111    <varlistentry>
 112     <term>--comp</term>
 113     <listitem><para>
 114       Returns full path to YAZ' ASN.1 compiler: yaz-asncomp.
 115      </para></listitem>
 116    </varlistentry>
 117
 118    <varlistentry>
 119     <term>-V</term>
 120     <listitem><para>
 121       Returns YAZ SHA1 ID (from Git) and version.
 122      </para></listitem>
 123    </varlistentry>
 124
 125   </variablelist>
 126  </refsect1>
 127
 128  <refsect1><title>FILES</title>
 129   <para>
 130    <filename>/usr/bin/yaz-config</filename>
 131   </para>
 132   <para>
 133    <filename>/usr/lib/libyaz*.a</filename>
 134   </para>
 135   <para>
 136    <filename>/usr/include/yaz/*.h</filename>
 137   </para>
 138   </refsect1>
 139  <refsect1><title>SEE ALSO</title>
 140   <para>
 141    yaz(7)
 142   </para>
 143   <para>
 144    Section "How to make apps using YAZ on UNIX" in the YAZ manual.
 145   </para>
 146  </refsect1>
 147 </refentry>
 148
 149 <!-- Keep this comment at the end of the file
 150 Local variables:
 151 mode: nxml
 152 nxml-child-indent: 1
 153 End:
 154 -->