doc/yazpp-config-man.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
   2 <!-- $Id: yazpp-config-man.xml,v 1.1 2006-04-24 08:55:28 marc Exp $ -->
   3 <refentry id="yazpp-config">
   4  <refmeta>
   5   <refentrytitle>yazpp-config</refentrytitle>
   6   <manvolnum>8</manvolnum>
   7  </refmeta>
   8
   9  <refnamediv>
  10   <refname>yazpp-config</refname>
  11   <refpurpose>Script to get information about YAZ.</refpurpose>
  12  </refnamediv>
  13
  14  <refsynopsisdiv>
  15   <cmdsynopsis>
  16    <command>yazpp-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>--comp</option></arg>
  23    <arg choice="opt" rep="repeat">libraries</arg>
  24   </cmdsynopsis>
  25  </refsynopsisdiv>
  26
  27  <refsect1><title>DESCRIPTION</title>
  28   <para>
  29    <command>yazpp-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   </variablelist>
  45
  46  </refsect1>
  47
  48  <refsect1><title>OPTIONS</title>
  49
  50   <variablelist>
  51    <varlistentry>
  52     <term>--prefix[=<replaceable>DIR</replaceable>]</term>
  53     <listitem><para>
  54       Returns prefix of YAZ or assume a different one if DIR is
  55       specified.
  56      </para></listitem>
  57    </varlistentry>
  58
  59    <varlistentry>
  60     <term>--version</term>
  61     <listitem><para>
  62       Returns version of YAZ.
  63      </para></listitem>
  64    </varlistentry>
  65
  66    <varlistentry>
  67     <term>--libs</term>
  68     <listitem><para>
  69       Library specification be used when using YAZ.
  70      </para></listitem>
  71    </varlistentry>
  72
  73    <varlistentry>
  74     <term>--lalibs</term>
  75     <listitem><para>
  76       Return library specification.
  77      </para></listitem>
  78    </varlistentry>
  79
  80    <varlistentry>
  81     <term>--cflags</term>
  82     <listitem><para>
  83       Return C Compiler flags.
  84      </para></listitem>
  85    </varlistentry>
  86
  87    <varlistentry>
  88     <term>--comp</term>
  89     <listitem><para>
  90       Returns full path to YAZ' ASN.1 compiler: yaz-asncomp.
  91      </para></listitem>
  92    </varlistentry>
  93
  94   </variablelist>
  95  </refsect1>
  96
  97  <refsect1><title>FILES</title>
  98   <para>
  99    <filename><replaceable>prefix</replaceable>/bin/yazpp-config</filename>
 100   </para>
 101   <para>
 102    <filename><replaceable>prefix</replaceable>/lib/libyazpp*.a</filename>
 103   </para>
 104   <para>
 105    <filename><replaceable>prefix</replaceable>/include/yazpp/*.h</filename>
 106   </para>
 107   </refsect1>
 108  <refsect1><title>SEE ALSO</title>
 109   <para>
 110    yaz(7)
 111   </para>
 112   <para>
 113    Section "How to make apps using YAZ on UNIX" in the YAZ manual.
 114   </para>
 115  </refsect1>
 116 </refentry>
 117
 118 <!-- Keep this comment at the end of the file
 119 Local variables:
 120 mode: sgml
 121 sgml-omittag:t
 122 sgml-shorttag:t
 123 sgml-minimize-attributes:nil
 124 sgml-always-quote-attributes:t
 125 sgml-indent-step:1
 126 sgml-indent-data:t
 127 sgml-parent-document:nil
 128 sgml-local-catalogs: nil
 129 sgml-namecase-general:t
 130 End:
 131 -->