Remove <info> from ref entry header
[metaproxy-moved-to-github.git] / doc / metaproxy-config.xml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
2     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
3  <!ENTITY copyright SYSTEM "copyright.xml">
4  <!ENTITY % local SYSTEM "local.ent">
5      %local;
6  <!ENTITY % idcommon SYSTEM "common/common.ent">
7      %idcommon;
8 ]>
9 <refentry id="ref-metaproxy-config">
10  <refentryinfo>
11   <productname>Metaproxy</productname>
12   <productnumber>&version;</productnumber>
13   <orgname>Index Data</orgname>
14  </refentryinfo>
15
16  <refmeta>
17   <refentrytitle>metaproxy-config</refentrytitle>
18   <manvolnum>1</manvolnum>
19   <refmiscinfo class="manual">Commands</refmiscinfo>
20  </refmeta>
21
22  <refnamediv>
23   <refname>metaproxy-config</refname>
24   <refpurpose>
25   script to get information about the installation of Metaproxy
26   </refpurpose>
27  </refnamediv>
28
29  <refsynopsisdiv>
30   <cmdsynopsis>
31    <command>metaproxy-config</command>
32    <arg choice="opt"><option>--prefix[=<replaceable>DIR</replaceable>]</option></arg>
33    <arg choice="opt"><option>--version</option></arg>
34    <arg choice="opt"><option>--libs</option></arg>
35    <arg choice="opt"><option>--lalibs</option></arg>
36    <arg choice="opt"><option>--cflags</option></arg>
37    <!-- <arg choice="opt"><option>- -comp</option></arg> -->
38    <!-- <arg choice="opt" rep="repeat">libraries</arg> -->
39   </cmdsynopsis>
40  </refsynopsisdiv>
41
42  <refsect1><title>DESCRIPTION</title>
43
44   <para>
45    <command>metaproxy-config</command> is a script that returns information
46    that your own software should use to build software that uses Metaproxy.
47   </para>
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 Metaproxy 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 Metaproxy.
66      </para></listitem>
67    </varlistentry>
68
69    <varlistentry>
70     <term>--libs</term>
71     <listitem><para>
72       Library specification be used when linking with Metaproxy libraries.
73      </para></listitem>
74    </varlistentry>
75
76    <varlistentry>
77     <term>--lalibs</term>
78     <listitem><para>
79       Returns library specification.
80      </para></listitem>
81    </varlistentry>
82
83    <varlistentry>
84     <term>--cflags</term>
85     <listitem><para>
86       Returns C++ Compiler flags.
87      </para></listitem>
88    </varlistentry>
89
90   </variablelist>
91  </refsect1>
92
93  <refsect1><title>FILES</title>
94   <para>
95    <filename><replaceable>prefix</replaceable>/bin/metaproxy-config</filename>
96   </para>
97   <para>
98    <filename><replaceable>prefix</replaceable>/lib/libmetaproxy*.a</filename>
99   </para>
100   <para>
101    <filename><replaceable>prefix</replaceable>/lib/metaproxy6/modules</filename>
102   </para>
103   <para>
104    <filename><replaceable>prefix</replaceable>/include/metaproxy</filename>
105   </para>
106  </refsect1>
107
108  <refsect1><title>SEE ALSO</title>
109   <para>
110    <citerefentry>
111     <refentrytitle>metaproxy</refentrytitle>
112     <manvolnum>1</manvolnum>
113    </citerefentry>
114   </para>
115   <para>
116    The Metaproxy
117    <ulink url="&url.metaproxy.doc;">manual</ulink>.
118   </para>
119  </refsect1>
120
121  &copyright;
122
123 </refentry>
124
125 <!-- Keep this comment at the end of the file
126 Local variables:
127 mode: nxml
128 nxml-child-indent: 1
129 End:
130 -->