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