doc/yazpp-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 <refentry id="yazpp-config">
   5  <refmeta>
   6   <refentrytitle>yazpp-config</refentrytitle>
   7   <manvolnum>8</manvolnum>
   8  </refmeta>
   9
  10  <refnamediv>
  11   <refname>yazpp-config</refname>
  12   <refpurpose>Script to get information about YAZ++.</refpurpose>
  13  </refnamediv>
  14
  15  <refsynopsisdiv>
  16   <cmdsynopsis>
  17    <command>yazpp-config</command>
  18    <arg choice="opt"><option>--prefix[=<replaceable>DIR</replaceable>]</option></arg>
  19    <arg choice="opt"><option>--version</option></arg>
  20    <arg choice="opt"><option>--libs</option></arg>
  21    <arg choice="opt"><option>--lalibs</option></arg>
  22    <arg choice="opt"><option>--cflags</option></arg>
  23    <!-- <arg choice="opt"><option>- -comp</option></arg> -->
  24    <!-- <arg choice="opt" rep="repeat">libraries</arg> -->
  25   </cmdsynopsis>
  26  </refsynopsisdiv>
  27
  28  <refsect1><title>DESCRIPTION</title>
  29   <para>
  30    <command>yazpp-config</command> is a script that returns information
  31    that your own software should use to build software that uses YAZ++.
  32   </para>
  33
  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
  90    <!--<varlistentry>
  91     <term>- -comp</term>
  92     <listitem><para>
  93       Returns full path to YAZ' ASN.1 compiler: yaz-asncomp.
  94      </para></listitem>
  95    </varlistentry>-->
  96
  97   </variablelist>
  98  </refsect1>
  99
 100  <refsect1><title>FILES</title>
 101   <para>
 102    <filename><replaceable>prefix</replaceable>/bin/yazpp-config</filename>
 103   </para>
 104   <para>
 105    <filename><replaceable>prefix</replaceable>/lib/libyazpp*.a</filename>
 106   </para>
 107   <para>
 108    <filename><replaceable>prefix</replaceable>/include/yazpp/*.h</filename>
 109   </para>
 110   </refsect1>
 111  <refsect1><title>SEE ALSO</title>
 112   <para>
 113    yaz(7)
 114   </para>
 115   <para>
 116    Section "How to make apps using YAZ on UNIX" in the YAZ manual.
 117   </para>
 118  </refsect1>
 119 </refentry>
 120
 121 <!-- Keep this comment at the end of the file
 122 Local variables:
 123 mode: sgml
 124 sgml-omittag:t
 125 sgml-shorttag:t
 126 sgml-minimize-attributes:nil
 127 sgml-always-quote-attributes:t
 128 sgml-indent-step:1
 129 sgml-indent-data:t
 130 sgml-parent-document:nil
 131 sgml-local-catalogs: nil
 132 sgml-namecase-general:t
 133 End:
 134 -->