doc/yaz-config-man.xml

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