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