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