doc/yazpp-config-man.xml

   1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" "">
   2 <!-- $Id: yazpp-config-man.xml,v 1.4 2006-04-25 12:37:05 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   <!--
  34   <para>
  35    The following libraries are supported:
  36   </para>
  37
  38   <variablelist>
  39    <varlistentry>
  40     <term>threads</term>
  41     <listitem><para>
  42       Use the threaded version of YAZ.
  43      </para></listitem>
  44    </varlistentry>
  45   </variablelist>
  46   -->
  47  </refsect1>
  48
  49  <refsect1><title>OPTIONS</title>
  50
  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
  60    <varlistentry>
  61     <term>--version</term>
  62     <listitem><para>
  63       Returns version of YAZ++.
  64      </para></listitem>
  65    </varlistentry>
  66
  67    <varlistentry>
  68     <term>--libs</term>
  69     <listitem><para>
  70       Library specification be used when using YAZ++.
  71      </para></listitem>
  72    </varlistentry>
  73
  74    <varlistentry>
  75     <term>--lalibs</term>
  76     <listitem><para>
  77       Return library specification.
  78      </para></listitem>
  79    </varlistentry>
  80
  81    <varlistentry>
  82     <term>--cflags</term>
  83     <listitem><para>
  84       Return C Compiler flags.
  85      </para></listitem>
  86    </varlistentry>
  87
  88
  89    <!--<varlistentry>
  90     <term>- -comp</term>
  91     <listitem><para>
  92       Returns full path to YAZ' ASN.1 compiler: yaz-asncomp.
  93      </para></listitem>
  94    </varlistentry>-->
  95
  96   </variablelist>
  97  </refsect1>
  98
  99  <refsect1><title>FILES</title>
 100   <para>
 101    <filename><replaceable>prefix</replaceable>/bin/yazpp-config</filename>
 102   </para>
 103   <para>
 104    <filename><replaceable>prefix</replaceable>/lib/libyazpp*.a</filename>
 105   </para>
 106   <para>
 107    <filename><replaceable>prefix</replaceable>/include/yazpp/*.h</filename>
 108   </para>
 109   </refsect1>
 110  <refsect1><title>SEE ALSO</title>
 111   <para>
 112    yaz(7)
 113   </para>
 114   <para>
 115    Section "How to make apps using YAZ on UNIX" in the YAZ manual.
 116   </para>
 117  </refsect1>
 118 </refentry>
 119
 120 <!-- Keep this comment at the end of the file
 121 Local variables:
 122 mode: sgml
 123 sgml-omittag:t
 124 sgml-shorttag:t
 125 sgml-minimize-attributes:nil
 126 sgml-always-quote-attributes:t
 127 sgml-indent-step:1
 128 sgml-indent-data:t
 129 sgml-parent-document:nil
 130 sgml-local-catalogs: nil
 131 sgml-namecase-general:t
 132 End:
 133 -->