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 <!-- $Id: yaz-config-man.xml,v 1.4 2006-04-24 12:41:00 marc Exp $ -->
   5 <refentry id="yaz-config">
   6  <refmeta>
   7   <refentrytitle>yaz-config</refentrytitle>
   8   <manvolnum>8</manvolnum>
   9  </refmeta>
  10
  11  <refnamediv>
  12   <refname>yaz-config</refname>
  13   <refpurpose>Script to get information about YAZ.</refpurpose>
  14  </refnamediv>
  15
  16  <refsynopsisdiv>
  17   <cmdsynopsis>
  18    <command>yaz-config</command>
  19    <arg choice="opt"><option>--prefix[=<replaceable>DIR</replaceable>]</option></arg>
  20    <arg choice="opt"><option>--version</option></arg>
  21    <arg choice="opt"><option>--libs</option></arg>
  22    <arg choice="opt"><option>--lalibs</option></arg>
  23    <arg choice="opt"><option>--cflags</option></arg>
  24    <arg choice="opt"><option>--comp</option></arg>
  25    <arg choice="opt" rep="repeat">libraries</arg>
  26   </cmdsynopsis>
  27  </refsynopsisdiv>
  28
  29  <refsect1><title>DESCRIPTION</title>
  30   <para>
  31    <command>yaz-config</command> is a script that returns information
  32    that your own software should use to build software that uses YAZ.
  33   </para>
  34
  35   <para>
  36    The following libraries are supported:
  37   </para>
  38
  39   <variablelist>
  40    <varlistentry>
  41     <term>threads</term>
  42     <listitem><para>
  43       Use the threaded version of YAZ.
  44      </para></listitem>
  45    </varlistentry>
  46   </variablelist>
  47
  48  </refsect1>
  49
  50  <refsect1><title>OPTIONS</title>
  51
  52   <variablelist>
  53    <varlistentry>
  54     <term>--prefix[=<replaceable>DIR</replaceable>]</term>
  55     <listitem><para>
  56       Returns prefix of YAZ or assume a different one if DIR is
  57       specified.
  58      </para></listitem>
  59    </varlistentry>
  60
  61    <varlistentry>
  62     <term>--version</term>
  63     <listitem><para>
  64       Returns version of YAZ.
  65      </para></listitem>
  66    </varlistentry>
  67
  68    <varlistentry>
  69     <term>--libs</term>
  70     <listitem><para>
  71       Library specification be used when using YAZ.
  72      </para></listitem>
  73    </varlistentry>
  74
  75    <varlistentry>
  76     <term>--lalibs</term>
  77     <listitem><para>
  78       Return library specification.
  79      </para></listitem>
  80    </varlistentry>
  81
  82    <varlistentry>
  83     <term>--cflags</term>
  84     <listitem><para>
  85       Return C Compiler flags.
  86      </para></listitem>
  87    </varlistentry>
  88
  89    <varlistentry>
  90     <term>--comp</term>
  91     <listitem><para>
  92       Returns full path to YAZ' ASN.1 compiler: yaz-asncomp.
  93      </para></listitem>
  94    </varlistentry>
  95
  96   </variablelist>
  97  </refsect1>
  98
  99  <refsect1><title>FILES</title>
 100   <para>
 101    <filename><replaceable>prefix</replaceable>/bin/yaz-config</filename>
 102   </para>
 103   <para>
 104    <filename><replaceable>prefix</replaceable>/lib/libyaz*.a</filename>
 105   </para>
 106   <para>
 107    <filename><replaceable>prefix</replaceable>/include/yaz/*.h</filename>
 108   </para>
 109   </refsect1>
 110  <refsect1><title>SEE ALSO</title>
 111   <para>
 112    yaz(7)
 113   </para>
 114   <para>
 115    Section "How to make apps using YAZ on UNIX" in the YAZ manual.
 116   </para>
 117  </refsect1>
 118 </refentry>
 119
 120 <!-- Keep this Emacs mode comment at the end of the file
 121 Local variables:
 122 mode: nxml
 123 End:
 124 -->
 125