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