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