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